| Argument | Type | Description |
|---|---|---|
after | String | Cursor for forward pagination |
before | String | Cursor for backward pagination |
filters | AccountsFilters | Filters |
first | Int | First |
last | Int | Last |
orderBy | [AccountsOrderBy] | Order by |
query( $filters: AccountsFilters, $first: Int, $orderBy: [AccountsOrderBy]) { accounts( filters: $filters, first: $first, orderBy: $orderBy ) { edges { node { id # Add other fields you need } } pageInfo { hasNextPage endCursor } }}{ "filters": {}, "first": 1, "orderBy": {}}| Argument | Type | Description |
|---|---|---|
filters | AccountsFilters | Filters |
query($filters: AccountsFilters) { accountsCount(filters: $filters) { id # Add other fields you need }}{ "filters": {}}| Argument | Type | Description |
|---|---|---|
limit | Int | Maximum number of results to return |
offset | Int | Number of results to skip for pagination |
updatedAtEnd | NaiveDateTime | Updated at end |
updatedAtStart | NaiveDateTime | Updated at start |
query( $limit: Int, $offset: Int, $updatedAtEnd: NaiveDateTime, $updatedAtStart: NaiveDateTime) { addresses( limit: $limit, offset: $offset, updatedAtEnd: $updatedAtEnd, updatedAtStart: $updatedAtStart ) { id # Add other fields you need }}{ "limit": 1, "offset": 1, "updatedAtEnd": {}, "updatedAtStart": {}}Lookup API keys for your org
query { apiKeys { id # Add other fields you need }}| Argument | Type | Description |
|---|---|---|
inputrequired | PhoneNumberInput! | Input |
query($input: PhoneNumberInput!) { checkDuplicatePhoneNumber(input: $input) { id # Add other fields you need }}{ "input": {}}Lookup a specific client by id
| Argument | Type | Description |
|---|---|---|
idrequired | ID! | Unique identifier |
query($id: ID!) { client(id: $id) { id # Add other fields you need }}{ "id": "1"}query($id: ID!) { clientTag(id: $id) { id # Add other fields you need }}{ "id": "1"}query { clientTags { id # Add other fields you need }}Get a list of clients within your organization's database. Depending on how many providers your organization has, you may need to page through your data with filters.
| Argument | Type | Description |
|---|---|---|
filters | ClientFilters | Filters |
insertedAtEnd | NaiveDateTime | Inserted at end |
insertedAtStart | NaiveDateTime | Inserted at start |
limit | Int | Maximum number of results to return |
offset | Int | Number of results to skip for pagination |
sortBy | SortOptions | Sort by |
updatedAtEnd | NaiveDateTime | Updated at end |
updatedAtStart | NaiveDateTime | Updated at start |
query( $filters: ClientFilters, $insertedAtEnd: NaiveDateTime, $insertedAtStart: NaiveDateTime, $limit: Int, $offset: Int, $sortBy: SortOptions, $updatedAtEnd: NaiveDateTime, $updatedAtStart: NaiveDateTime) { clients( filters: $filters, insertedAtEnd: $insertedAtEnd, insertedAtStart: $insertedAtStart, limit: $limit, offset: $offset, sortBy: $sortBy, updatedAtEnd: $updatedAtEnd, updatedAtStart: $updatedAtStart ) { id # Add other fields you need }}{ "filters": {}, "insertedAtEnd": {}, "insertedAtStart": {}, "limit": 1, "offset": 1, "sortBy": {}, "updatedAtEnd": {}, "updatedAtStart": {}}| Argument | Type | Description |
|---|---|---|
filters | ClientFilters | Filters |
insertedAtEnd | NaiveDateTime | Inserted at end |
insertedAtStart | NaiveDateTime | Inserted at start |
sortBy | SortOptions | Sort by |
query( $filters: ClientFilters, $insertedAtEnd: NaiveDateTime, $insertedAtStart: NaiveDateTime, $sortBy: SortOptions) { clientsCount( filters: $filters, insertedAtEnd: $insertedAtEnd, insertedAtStart: $insertedAtStart, sortBy: $sortBy ) { id # Add other fields you need }}{ "filters": {}, "insertedAtEnd": {}, "insertedAtStart": {}, "sortBy": {}}query( $limit: Int, $offset: Int, $updatedAtEnd: DateTime, $updatedAtStart: DateTime) { coowners( limit: $limit, offset: $offset, updatedAtEnd: $updatedAtEnd, updatedAtStart: $updatedAtStart ) { id # Add other fields you need }}{ "limit": 1, "offset": 1, "updatedAtEnd": {}, "updatedAtStart": {}}Count new clients based on filters between a range and segment
| Argument | Type | Description |
|---|---|---|
end | DateTime | Ending point for the range |
segmentrequired | TimeSegment! | Segment |
start | DateTime | Starting point for the range |
query( $end: DateTime, $segment: TimeSegment!, $start: DateTime) { countNewClients( end: $end, segment: $segment, start: $start ) { id # Add other fields you need }}{ "end": {}, "segment": {}, "start": {}}| Argument | Type | Description |
|---|---|---|
clientIdrequired | ID! | ID of the client (pet owner) |
query($clientId: ID!) { externalCommPreferences(clientId: $clientId) { id # Add other fields you need }}{ "clientId": "1"}| Argument | Type | Description |
|---|---|---|
input | ExternalSearchInput | Input data for external search operation |
query($input: ExternalSearchInput) { externalSearch(input: $input) { id # Add other fields you need }}{ "input": {}}| Argument | Type | Description |
|---|---|---|
locationIdrequired | ID! | ID of the location |
query($locationId: ID!) { permissions(locationId: $locationId) { id # Add other fields you need }}{ "locationId": "1"}| Argument | Type | Description |
|---|---|---|
limit | Int | Maximum number of results to return |
offset | Int | Number of results to skip for pagination |
updatedAtEnd | NaiveDateTime | Updated at end |
updatedAtStart | NaiveDateTime | Updated at start |
query( $limit: Int, $offset: Int, $updatedAtEnd: NaiveDateTime, $updatedAtStart: NaiveDateTime) { phoneNumbers( limit: $limit, offset: $offset, updatedAtEnd: $updatedAtEnd, updatedAtStart: $updatedAtStart ) { id # Add other fields you need }}{ "limit": 1, "offset": 1, "updatedAtEnd": {}, "updatedAtStart": {}}Lookup a specific provider by id. All users in Vetspire are listed as a provider and have an id.
| Argument | Type | Description |
|---|---|---|
idrequired | ID! | provider's primary id |
query($id: ID!) { provider(id: $id) { id # Add other fields you need }}{ "id": "1"}| Argument | Type | Description |
|---|---|---|
providerIdrequired | ID! | ID of the provider |
query($providerId: ID!) { providerAuthToken(providerId: $providerId) { id # Add other fields you need }}{ "providerId": "1"}| Argument | Type | Description |
|---|---|---|
idrequired | ID! | Unique identifier |
query($id: ID!) { providerRole(id: $id) { id # Add other fields you need }}{ "id": "1"}| Argument | Type | Description |
|---|---|---|
updatedAtEnd | NaiveDateTime | Updated at end |
updatedAtStart | NaiveDateTime | Updated at start |
query( $updatedAtEnd: NaiveDateTime, $updatedAtStart: NaiveDateTime) { providerRoles( updatedAtEnd: $updatedAtEnd, updatedAtStart: $updatedAtStart ) { id # Add other fields you need }}{ "updatedAtEnd": {}, "updatedAtStart": {}}query( $ids: [ID], $locationId: ID, $onlyActive: Boolean, $vetOnly: Boolean) { providers( ids: $ids, locationId: $locationId, onlyActive: $onlyActive, vetOnly: $vetOnly ) { id # Add other fields you need }}{ "ids": "1", "locationId": "1", "onlyActive": true, "vetOnly": true}query { relationships { id # Add other fields you need }}Full-text search for clients or patients at a org
query( $clientId: ID, $limit: Int, $locationId: ID, $orgId: ID, $query: String!) { searchAccounts( clientId: $clientId, limit: $limit, locationId: $locationId, orgId: $orgId, query: $query ) { id # Add other fields you need }}{ "clientId": "1", "limit": 1, "locationId": "1", "orgId": "1", "query": "example"}query { totalClients { id # Add other fields you need }}Lookup the viewer
query { viewer { id # Add other fields you need }}Lookup the viewer
query { viewerSubscription { id # Add other fields you need }}