Sources

GET Get Sources

https://<subdomain>.nimbus.io/api/sources

Get all contact sources.
Param Type Required
name string optional

Sample Response:

HEADERS

Accept
application/prs.nimbus.v1+json
Authorization
Bearer <token>

Example Request:

Get Sources
curl --location --request GET 'https://<subdomain>.nimbus.io/api/sources' \
--header 'Accept: application/prs.nimbus.v1+json' \
--header 'Authorization: Bearer <token>'

POST Create Source

https://<subdomain>.nimbus.io/api/sources

Create new contact source.
Param Type Required
name string *required

Sample Response:

HEADERS

Accept
application/prs.nimbus.v1+json
Authorization
Bearer <token>
BODY formdata

name
Test Source 1

Example Request:

Get Sources
curl --location --request GET 'https://<subdomain>.nimbus.io/api/sources' \
--header 'Accept: application/prs.nimbus.v1+json' \
--header 'Authorization: Bearer <token>'
--form 'name=Test Source 1'

Contacts

GET Get Contacts

https://<subdomain>.nimbus.io/api/contacts

Get all contacts.
Param Type Required
source_id integer * required
phone string optional
name string optional

Sample Response:

HEADERS

Accept
application/prs.nimbus.v1+json
Authorization
Bearer <token>

Example Request:

Get Sources
curl --location --request GET 'https://<subdomain>.nimbus.io/api/contacts' \
--header 'Accept: application/prs.nimbus.v1+json' \
--header 'Authorization: Bearer <token>'

POST Create Contact

https://<subdomain>.nimbus.io/api/contacts

Create new contact.
Param Type Required
source_id integer *required
first_name string optional
last_name string optional
phone integer *required
email string optional
address string optional
city string optional
state string optional
zip string optional

Sample Response:

HEADERS

Accept
application/prs.nimbus.v1+json
Authorization
Bearer <token>
BODY formdata

source_id
26
first_name
Dejan
last_name
Prole
phone
12222222223
address
Test 123
city
New York
state
NY
zip
11000

Example Request:

Get Sources
curl --location --request POST 'https://<subdomain>.nimbus.io/api/contacts' \
--header 'Accept: application/prs.nimbus.v1+json' \
--header 'Authorization: Bearer <token>'
--form 'source_id=26' \
--form 'first_name=Dejan' \
--form 'last_name=Prole' \
--form 'phone=12222222223' \
--form '[email protected]' \
--form 'address=Test 123' \
--form 'city=New York' \
--form 'state=NY' \
--form 'zip=11000' \