Skip to main content
GET
Get contacts for an organisation

Authorizations

Authorization
string
header
required

Enter your personal access token (PAT) to authenticate

Path Parameters

workspaceUuid
string<uuid>
required

The UUID of the workspace

Example:

"550e8400-e29b-41d4-a716-446655440000"

Query Parameters

domain
string

Either organisation_uuid or domain must be provided

Example:

"pirateinc.com"

organisation_uuid
string<uuid>

Either organisation_uuid or domain must be provided

Example:

"550e8400-e29b-41d4-a716-446655440000"

page
integer

The page number for pagination

Example:

1

size
integer

The number of organisations per page (1-1000)

Required range: 1 <= x <= 1000
Example:

10

Response

A paginated list of the contacts. Contacts are served from Snitcher's store; when a domain has not been looked up recently the lookup runs in the background and refreshing is true, meaning the list may still grow. Poll the same request until refreshing is false.

current_page
integer
Example:

1

last_page
integer
Example:

10

per_page
integer
Example:

15

total
integer
Example:

150

next_page_url
string | null
Example:

"https://api.example.com/v1/workspaces?page=2"

prev_page_url
string | null
Example:

null

first_page_url
string | null
Example:

"https://api.example.com/v1/workspaces?page=1"

last_page_url
string | null
Example:

"https://api.example.com/v1/workspaces?page=10"

path
string | null
Example:

"https://api.example.com/v1/workspaces"

from
integer | null
Example:

1

to
integer | null
Example:

15

data
Organisation contact · object[]
success
boolean
Example:

true

refreshing
boolean

Whether a contact lookup for this domain is still running in the background.

Example:

false