Contacts

Retrieve a contact

GET/api/v1/contacts/{id}Scope contacts:read

One contact, with the trips they are on.

Path parameters

idstring

Query parameters

No parameters.

Returns

A Contact object.

object"contact"

idstring

Unique id of the contact.

namestring

The full name, as the agency writes it.

first_namestring or null

First name, when the agency split the name.

last_namestring or null

Last name, when the agency split the name.

emailstring or null

Email address.

phonestring or null

Phone number, as typed.

typeenum

What the person is to the agency.

travelerprospectpartnersupplierother

job_titlestring or null

Job title.

date_of_birthdate or null

YYYY-MM-DD.

genderstring or null

As recorded by the agency.

avatar_urlstring or null

Picture of the person.

addressobject

Postal address.

+ Show 6 child attributes

line1string or null

line2string or null

citystring or null

statestring or null

postal_codestring or null

countrystring or null

tripsarray of objectoptional

Only on GET /contacts/{id}: the trips where this person is the main contact or has a seat on the roster. A main contact need not travel. primary says whether they are the main contact. Templates never appear.

+ Show 2 child attributes

idstring

primaryboolean

created_attimestamp

When it was created. ISO 8601, UTC.

updated_attimestamp

Its last change. Use it with updated_since to sync. ISO 8601, UTC.

Errors

401unauthorizedNo key, a malformed one, or a key that does not exist or was revoked. Send it as Authorization: Bearer <key>.

403api_not_enabledRoundPlan has not turned on API access for this agency.

403subscription_inactiveThe agency's trial expired or its subscription ended.

403insufficient_scopeThe key cannot read this. An owner adds contacts:read to a key in Settings → API.

404not_foundNothing with that id in this agency.

429rate_limitedToo many requests. Wait the seconds in Retry-After. See Errors and rate limits.

500internal_errorSomething went wrong on our side. Retry later.