Skip to main content
GET
Export contacts as CSV

Authorizations

Api-Token
string
header
required

Server-to-server authentication. Generate a token in the admin UI at Settings → Developers → API Access. Send the raw token in the Api-Token header — there is no Bearer prefix.

Tokens can be marked read-only at creation time, in which case the API rejects any non-GET request with 403 Forbidden.

Query Parameters

page
integer
default:1

The collection page number

itemsPerPage
integer
default:500

The number of items per page

Required range: 0 <= x <= 500
pagination
boolean

Enable or disable pagination

name
string
email
string
email[]
string[]
town
string
town[]
string[]
country
string
country[]
string[]
isNewsletterSubscribed
boolean
isNewsletterSubscribed[]
boolean[]
customFieldValues
string
customFieldValues[]
string[]
status
string
status[]
string[]
tags.tag
string
tags.tag[]
string[]
source
string
source[]
string[]
order[id]
enum<string>
default:asc
Available options:
asc,
desc
order[name]
enum<string>
default:asc
Available options:
asc,
desc
order[isNewsletterSubscribed]
enum<string>
default:asc
Available options:
asc,
desc
order[dateCreated]
enum<string>
default:asc
Available options:
asc,
desc
order[source]
enum<string>
default:asc
Available options:
asc,
desc
exists[isNewsletterSubscribed]
boolean

Response

Contact collection

id
integer
read-only
name
string | null
email
string | null
phone
string | null
organisation
string | null
role
string | null
twitter
string | null
linkedin
string | null
instagram
string | null
country
object | null
isNewsletterSubscribed
boolean | null
stripeCustomerId
string | null
town
object | null
dateCreated
string<date-time> | null
read-only
isValidatedIdentity
boolean
read-only
isValidatedIdentityPending
boolean
read-only
localCenter
object | null
product
string<iri-reference> | null
Example:

"/api/v1/products/1"

companyIdentifier
string | null
companyName
string | null
companyAddress
string | null
professionOrganisationRole
string | null
companyRegNo
string | null
notes
string | null
lastStatusUpdate
string<date-time> | null
tags
string<iri-reference>[]
Example:
gender
string | null
source
string | null
fullName
string | null
read-only
firstName
string | null
read-only
lastName
string | null
read-only
statusName
string | null
read-only
dateBirthFormatted
string | null
read-only