Contact

Resource: Contact — CRUD endpoints

List Contact (find where)

GET

https://api.aerion.app

/v1/contacts

OAuth 2.0

Bearer (Opaque)

Find a list of Contact records that match the specified criteria.

Tip: All query parameters accept multiple values for array filtering — e.g. ?id=1&id=2 or ?id[]=1&id[]=2. This also works within the where parameter: ?where={"id":[1,2,3]}.

Note: The per-attribute filter parameters and the where parameter are mutually exclusive. If where is supplied, the per-attribute filters are ignored — put all filter criteria inside where instead. limit, skip, sort, and populate are unaffected.

List Contact (find where) › query Parameters

client

integer

ID of the associated Client record. The client this contact belongs to.

id

integer · unique

Filter by record ID

createdAt

string

Filter by creation date (YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.sssZ). This is an exact match filter; for range queries (greater than, less than), use the where parameter instead

updatedAt

string

Filter by last update date (YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.sssZ). This is an exact match filter; for range queries (greater than, less than), use the where parameter instead

where

string

A JSON-encoded Waterline criteria for advanced filtering. Only whitelisted criteria are supported: client, id, createdAt, updatedAt. Sub-attribute modifiers such as startsWith, >=, <=, >, <, and != are supported on any whitelisted criterion. The contains modifier is not supported on this model.

Note: If where is supplied, the per-attribute filter query parameters above are ignored — where is the entire criteria. (limit, skip, sort, and populate are unaffected.) To combine filters, put them all inside where.

e.g. ?where={"startDate":{">=":"2026-06-01","<":"2026-07-01"}}

limit

integer · max: 50000

The maximum number of records to return. Defaults to 10000, capped at 50000.

Default: 10000

skip

integer

The number of records to skip (useful for pagination).

sort

string

The sort order. By default, returned records are sorted by primary key value in ascending order.

e.g. ?sort=lastName%20ASC

List Contact (find where) › Responses

Responds with a paged list of Contact records that match the specified criteria

contact[]

object

GET/v1/contacts

curl --request GET \
  --url https://api.aerion.app/v1/contacts

Example Responses

{
  "contacts": [
    {
      "createdAt": "2024-08-25T15:00:00Z",
      "updatedAt": "2024-08-25T15:00:00Z",
      "id": 0,
      "title": "title",
      "firstname": "firstname",
      "lastname": "lastname",
      "department": "department",
      "position": "position",
      "email": "test@example.com",
      "birthday": "2024-08-25",
      "phone": "phone",
      "phoneMobile": "phoneMobile",
      "fax": "fax",
      "street": "street",
      "addressAddon": "addressAddon",
      "postcode": "postcode",
      "city": "city",
      "comment": "comment",
      "country": "country",
      "client": 0
    }
  ],
  "meta": {
    "total": 0,
    "limit": 0,
    "skip": 0
  }
}

json

application/json

Create Contact

POST

https://api.aerion.app

/v1/contacts

OAuth 2.0

Bearer (Opaque)

Create a new Contact record.

Create Contact › Request Body

contact · required

Aerion model Contact

Create Contact › Responses

Responds with a JSON dictionary representing the newly created Contact instance

contact

Aerion model Contact

POST/v1/contacts

curl --request POST \
  --url https://api.aerion.app/v1/contacts \
  --header 'Content-Type: application/json' \
  --data '
{
  "contact": {
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "id": 0,
    "title": "title",
    "firstname": "firstname",
    "lastname": "lastname",
    "department": "department",
    "position": "position",
    "email": "test@example.com",
    "birthday": "2024-08-25",
    "phone": "phone",
    "phoneMobile": "phoneMobile",
    "fax": "fax",
    "street": "street",
    "addressAddon": "addressAddon",
    "postcode": "postcode",
    "city": "city",
    "comment": "comment",
    "country": "country",
    "client": 0
  }
}
'

Example Request Body

{
  "contact": {
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "id": 0,
    "title": "title",
    "firstname": "firstname",
    "lastname": "lastname",
    "department": "department",
    "position": "position",
    "email": "test@example.com",
    "birthday": "2024-08-25",
    "phone": "phone",
    "phoneMobile": "phoneMobile",
    "fax": "fax",
    "street": "street",
    "addressAddon": "addressAddon",
    "postcode": "postcode",
    "city": "city",
    "comment": "comment",
    "country": "country",
    "client": 0
  }
}

json

Example Responses

{
  "contact": {
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "id": 0,
    "title": "title",
    "firstname": "firstname",
    "lastname": "lastname",
    "department": "department",
    "position": "position",
    "email": "test@example.com",
    "birthday": "2024-08-25",
    "phone": "phone",
    "phoneMobile": "phoneMobile",
    "fax": "fax",
    "street": "street",
    "addressAddon": "addressAddon",
    "postcode": "postcode",
    "city": "city",
    "comment": "comment",
    "country": "country",
    "client": 0
  }
}

json

application/json

Get Contact (find one)

GET

https://api.aerion.app

/v1/contacts/{id}

OAuth 2.0

Bearer (Opaque)

Look up the Contact record with the specified ID.

Get Contact (find one) › path Parameters

id

integer · unique · required

The desired Contact record's primary key value

Get Contact (find one) › Responses

Responds with a single Contact record as a JSON dictionary

contact

Aerion model Contact

Update Contact

PUT

https://api.aerion.app

/v1/contacts/{id}

OAuth 2.0

Bearer (Opaque)

Partially update an existing Contact record. Despite using PUT, this endpoint applies PATCH semantics — only the fields included in the request body are modified; omitted fields are left unchanged.

Update Contact › path Parameters

id

integer · unique · required

The desired Contact record's primary key value

Update Contact › Request Body

contact · required

Aerion model Contact

Update Contact › Responses

Responds with the newly updated Contact record as a JSON dictionary

contact

Aerion model Contact

PUT/v1/contacts/{id}

curl --request PUT \
  --url https://api.aerion.app/v1/contacts/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "contact": {
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "id": 0,
    "title": "title",
    "firstname": "firstname",
    "lastname": "lastname",
    "department": "department",
    "position": "position",
    "email": "test@example.com",
    "birthday": "2024-08-25",
    "phone": "phone",
    "phoneMobile": "phoneMobile",
    "fax": "fax",
    "street": "street",
    "addressAddon": "addressAddon",
    "postcode": "postcode",
    "city": "city",
    "comment": "comment",
    "country": "country",
    "client": 0
  }
}
'

Example Request Body

{
  "contact": {
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "id": 0,
    "title": "title",
    "firstname": "firstname",
    "lastname": "lastname",
    "department": "department",
    "position": "position",
    "email": "test@example.com",
    "birthday": "2024-08-25",
    "phone": "phone",
    "phoneMobile": "phoneMobile",
    "fax": "fax",
    "street": "street",
    "addressAddon": "addressAddon",
    "postcode": "postcode",
    "city": "city",
    "comment": "comment",
    "country": "country",
    "client": 0
  }
}

json

Example Responses

{
  "contact": {
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "id": 0,
    "title": "title",
    "firstname": "firstname",
    "lastname": "lastname",
    "department": "department",
    "position": "position",
    "email": "test@example.com",
    "birthday": "2024-08-25",
    "phone": "phone",
    "phoneMobile": "phoneMobile",
    "fax": "fax",
    "street": "street",
    "addressAddon": "addressAddon",
    "postcode": "postcode",
    "city": "city",
    "comment": "comment",
    "country": "country",
    "client": 0
  }
}

json

application/json

Delete Contact (destroy)

DELETE

https://api.aerion.app

/v1/contacts/{id}

OAuth 2.0

Bearer (Opaque)

Delete the Contact record with the specified ID.

Delete Contact (destroy) › path Parameters

id

integer · unique · required

The desired Contact record's primary key value

Delete Contact (destroy) › Responses

Record successfully deleted

No data returned

Color Document

Aerion API

Contact

Resource: Contact — CRUD endpoints

List Contact (find where)

GET

https://api.aerion.app

/v1/contacts

OAuth 2.0

Bearer (Opaque)

Find a list of Contact records that match the specified criteria.

Tip: All query parameters accept multiple values for array filtering — e.g. ?id=1&id=2 or ?id[]=1&id[]=2. This also works within the where parameter: ?where={"id":[1,2,3]}.

List Contact (find where) › query Parameters

client

integer

ID of the associated Client record. The client this contact belongs to.

id

integer · unique

Filter by record ID

createdAt

string

Filter by creation date (YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.sssZ). This is an exact match filter; for range queries (greater than, less than), use the where parameter instead

updatedAt

string

Filter by last update date (YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.sssZ). This is an exact match filter; for range queries (greater than, less than), use the where parameter instead

where

string

e.g. ?where={"startDate":{">=":"2026-06-01","<":"2026-07-01"}}

limit

integer · max: 50000

The maximum number of records to return. Defaults to 10000, capped at 50000.

Default: 10000

skip

integer

The number of records to skip (useful for pagination).

sort

string

The sort order. By default, returned records are sorted by primary key value in ascending order.

e.g. ?sort=lastName%20ASC

List Contact (find where) › Responses

Responds with a paged list of Contact records that match the specified criteria

contact[]

object

GET/v1/contacts

curl --request GET \
  --url https://api.aerion.app/v1/contacts

Example Responses

{
  "contacts": [
    {
      "createdAt": "2024-08-25T15:00:00Z",
      "updatedAt": "2024-08-25T15:00:00Z",
      "id": 0,
      "title": "title",
      "firstname": "firstname",
      "lastname": "lastname",
      "department": "department",
      "position": "position",
      "email": "test@example.com",
      "birthday": "2024-08-25",
      "phone": "phone",
      "phoneMobile": "phoneMobile",
      "fax": "fax",
      "street": "street",
      "addressAddon": "addressAddon",
      "postcode": "postcode",
      "city": "city",
      "comment": "comment",
      "country": "country",
      "client": 0
    }
  ],
  "meta": {
    "total": 0,
    "limit": 0,
    "skip": 0
  }
}

json

application/json

Create Contact

POST

https://api.aerion.app

/v1/contacts

OAuth 2.0

Bearer (Opaque)

Create a new Contact record.

Create Contact › Request Body

contact · required

Aerion model Contact

Create Contact › Responses

Responds with a JSON dictionary representing the newly created Contact instance

contact

Aerion model Contact

POST/v1/contacts

curl --request POST \
  --url https://api.aerion.app/v1/contacts \
  --header 'Content-Type: application/json' \
  --data '
{
  "contact": {
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "id": 0,
    "title": "title",
    "firstname": "firstname",
    "lastname": "lastname",
    "department": "department",
    "position": "position",
    "email": "test@example.com",
    "birthday": "2024-08-25",
    "phone": "phone",
    "phoneMobile": "phoneMobile",
    "fax": "fax",
    "street": "street",
    "addressAddon": "addressAddon",
    "postcode": "postcode",
    "city": "city",
    "comment": "comment",
    "country": "country",
    "client": 0
  }
}
'

Example Request Body

{
  "contact": {
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "id": 0,
    "title": "title",
    "firstname": "firstname",
    "lastname": "lastname",
    "department": "department",
    "position": "position",
    "email": "test@example.com",
    "birthday": "2024-08-25",
    "phone": "phone",
    "phoneMobile": "phoneMobile",
    "fax": "fax",
    "street": "street",
    "addressAddon": "addressAddon",
    "postcode": "postcode",
    "city": "city",
    "comment": "comment",
    "country": "country",
    "client": 0
  }
}

json

Example Responses

{
  "contact": {
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "id": 0,
    "title": "title",
    "firstname": "firstname",
    "lastname": "lastname",
    "department": "department",
    "position": "position",
    "email": "test@example.com",
    "birthday": "2024-08-25",
    "phone": "phone",
    "phoneMobile": "phoneMobile",
    "fax": "fax",
    "street": "street",
    "addressAddon": "addressAddon",
    "postcode": "postcode",
    "city": "city",
    "comment": "comment",
    "country": "country",
    "client": 0
  }
}

json

application/json

Get Contact (find one)

GET

https://api.aerion.app

/v1/contacts/{id}

OAuth 2.0

Bearer (Opaque)

Look up the Contact record with the specified ID.

Get Contact (find one) › path Parameters

id

integer · unique · required

The desired Contact record's primary key value

Get Contact (find one) › Responses

Responds with a single Contact record as a JSON dictionary

contact

Aerion model Contact

Update Contact

PUT

https://api.aerion.app

/v1/contacts/{id}

OAuth 2.0

Bearer (Opaque)

Update Contact › path Parameters

id

integer · unique · required

The desired Contact record's primary key value

Update Contact › Request Body

contact · required

Aerion model Contact

Update Contact › Responses

Responds with the newly updated Contact record as a JSON dictionary

contact

Aerion model Contact

PUT/v1/contacts/{id}

curl --request PUT \
  --url https://api.aerion.app/v1/contacts/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "contact": {
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "id": 0,
    "title": "title",
    "firstname": "firstname",
    "lastname": "lastname",
    "department": "department",
    "position": "position",
    "email": "test@example.com",
    "birthday": "2024-08-25",
    "phone": "phone",
    "phoneMobile": "phoneMobile",
    "fax": "fax",
    "street": "street",
    "addressAddon": "addressAddon",
    "postcode": "postcode",
    "city": "city",
    "comment": "comment",
    "country": "country",
    "client": 0
  }
}
'

Example Request Body

{
  "contact": {
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "id": 0,
    "title": "title",
    "firstname": "firstname",
    "lastname": "lastname",
    "department": "department",
    "position": "position",
    "email": "test@example.com",
    "birthday": "2024-08-25",
    "phone": "phone",
    "phoneMobile": "phoneMobile",
    "fax": "fax",
    "street": "street",
    "addressAddon": "addressAddon",
    "postcode": "postcode",
    "city": "city",
    "comment": "comment",
    "country": "country",
    "client": 0
  }
}

json

Example Responses

{
  "contact": {
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "id": 0,
    "title": "title",
    "firstname": "firstname",
    "lastname": "lastname",
    "department": "department",
    "position": "position",
    "email": "test@example.com",
    "birthday": "2024-08-25",
    "phone": "phone",
    "phoneMobile": "phoneMobile",
    "fax": "fax",
    "street": "street",
    "addressAddon": "addressAddon",
    "postcode": "postcode",
    "city": "city",
    "comment": "comment",
    "country": "country",
    "client": 0
  }
}

json

application/json

Delete Contact (destroy)

DELETE

https://api.aerion.app

/v1/contacts/{id}

OAuth 2.0

Bearer (Opaque)

Delete the Contact record with the specified ID.

Delete Contact (destroy) › path Parameters

id

integer · unique · required

The desired Contact record's primary key value

Delete Contact (destroy) › Responses

Record successfully deleted

No data returned

Color Document