Table of Contents

Connecting

URL

https://api.realmalliance.com/graphql/public

HTTP Method

POST

Authentication

All requests must contain these HTTP headers:

• x-deployment-id
• x-api-key

Both of which will be provided to you securely.

The API key is a sensitive secret and should be treated like a password, thus stored securely (i.e. not as plain text in a digital file)

Common elements

<aside> 💡

! indicates a required input argument

</aside>

PaginationInput

All list queries in our schema are paginated (batched) so that there is a limit on the number of records that can be fetched at one time.

input PaginationInput {
	# How many records to include in response - i.e. a limit
  take: Int!
  # Starting after the cursor (ID) of a record, typically the ID of the last record in the previous page of records
  after: String
  orderBy: OrderByInput
}

Example argument

{
  "take": 25,
  "after": "id-123",
  "orderBy": {
    "field": "occurredAt",
    "direction": "desc"
  }
},