Account

get

This method is used to retrieve information about the email addresses associated with user accounts. Each email address entry provides essential details about the email address, such as its verification status, whether it is the primary email for the user, and the associated user ID.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Query parameters

emailstringOptional

Query parameter email used to filter results based on specific conditions.

idintegerOptional

Query parameter id used to filter results based on specific conditions.

id__gtintegerOptional

Filters records where id is greater than the given value.

id__gteintegerOptional

Filters records where id is greater than or equal to the given value.

id__ltintegerOptional

Filters records where id is less than the given value.

id__lteintegerOptional

Filters records where id is less than or equal to the given value.

limitinteger · max: 1000Optional

Limits the number of records returned in a single page. The maximum is 1000. A higher value is capped at 1000 and the request still succeeds.

pageintegerOptional

Query parameter page used to filter results based on specific conditions.

primarybooleanOptional

Query parameter primary used to filter results based on specific conditions.

sortstringOptional

Query parameter sort used to filter results based on specific conditions.

userintegerOptional

Query parameter user used to filter results based on specific conditions.

verifiedbooleanOptional

Query parameter verified used to filter results based on specific conditions.

Responses

200

Successful response for status code 200.

application/json

countintegerOptional

Numerical value representing quantity or total amount.

Example: 123

nextstring · uri · nullableOptional

This field defines the URL of the next page.

Example: http://api.example.org/accounts/?page=4

previousstring · uri · nullableOptional

This field defines the URL of the previous page.

Example: http://api.example.org/accounts/?page=2

get/account/email-addresses/

GET /account/email-addresses/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

Successful response for status code 200.

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "email": "[e-mail]",
      "id": 1,
      "primary": true,
      "user": 1,
      "verified": true
    }
  ]
}

get

/account/email-addresses/{id}/

This method is used to retrieve information about the email addresses associated with user accounts. Each email address entry provides essential details about the email address, such as its verification status, whether it is the primary email for the user, and the associated user ID. This endpoint retrieves a specific record by its unique identifier.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idintegerRequired

A unique integer value identifying this e-posta adresi.

Responses

200

Successful response for status code 200.

application/json

emailstring · email · max: 254Optional

Email address of the user or entity.

idintegerOptional

Unique identifier for the record.

primarybooleanOptional

This field defines whether the address is the default among the user's addresses.

userintegerOptional

This field defines the user who triggered the event.

verifiedbooleanOptional

This field defines whether the email address has been verified.

404

Object not found.

application/json

get/account/email-addresses/{id}/

GET /api/v1/remote/1/data-warehouse/account/email-addresses/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "email": "[e-mail]",
  "id": 1,
  "primary": true,
  "user": 1,
  "verified": true
}