People
List people
Returns the people owned by the authenticated team, ordered by name by default. Sub-teams' people are not included. People above the token's classification ceiling are left out. For example, GET /v1/people?limit=5 returns the first five people.
gethttps://api.govdash.us/v1/people
Authorization
Your API key as a bearer token, for example Bearer gd_live_....
See Authentication for how to create a key.
Query parameters
Return the objects after this cursor: the previous page's pageInfo.endCursor, or any edge's cursor. Omit it to start at the first page.
Number of objects to return, from 1 to 100. Defaults to 20.
Sort field. Defaults to name.
One of:
Sort direction. Keep the same sort and filters when following a cursor.
One of:
Only records updated at or after this time.
Only people whose first and last name contain this text, ignoring case. Title, middle name and suffix are not searched, and punctuation in names is stored as spaces.
Only people whose email address contains this text, ignoring case.
Headers
The dated API version this request is written against. Responses keep that version's shape after newer versions ship.
One of:
Response
200 · application/jsonOne page of a list.
The objects on this page, in list order.
Show child attributesHide child attributes
Show child attributesHide child attributes
Person identifier.
Object type, always person.
Data classification of the person.
One of:
Full display name, combined from the name parts.
Name prefix, title, or rank such as Dr., CPL, or Gen.
First (given) name.
Middle name.
Last (family) name.
Name suffix such as Jr., Sr., or III.
Email address.
Phone number.
LinkedIn profile URL.
When the person was last updated.
Companies and agencies the person works for. Employers the token cannot read are left out.
Show child attributesHide child attributes
Identifier of the employing company.
Identifier of the employing agency.
Whether this is the person's primary employment.
Pass as cursor to fetch the objects after this one.
Where this page sits in the list.
Show child attributesHide child attributes
Whether more objects follow this page. Pass endCursor as cursor to fetch them.
Whether this page was fetched after a cursor.
The first edge's cursor. null when the page is empty.
The last edge's cursor. null when the page is empty.
Errors
Every error returns a stable error.code to branch on and an error.message that says what went wrong, like the examples below. See Errors for how to handle each one.
A query parameter is malformed, such as a changed or reused cursor.
The cursor is invalid. Pass an `endCursor` or edge `cursor` unchanged.
The key's service account doesn't have the permission this needs, or your team's access has ended.
You do not have permission to perform this action.
The request is well formed, but GovDash won't make this change. The message says why, when it can.
The request failed validation.
You sent too many requests. Wait the seconds in the retry-after header, then retry.
This access token exceeded its read rate limit.
Something went wrong on GovDash's side, usually a bug. Retry with backoff, and check before retrying a create.
An unexpected error occurred.
GovDash is briefly unavailable and didn't run the request. Retry after retry-after.
The service is temporarily unavailable. Try again later.