Phone Numbers

List all PhoneNumbers

get

Returns an array of phone number objects available to the brand account.

Authorizations

basicAuth

AuthorizationstringRequired

Path parameters

AccountSIDstringRequired

The unique identifier for the account.

Query parameters

IdstringOptional

Filter by specific ID values (comma-separated).

LastDateAssignedstring · date-timeOptional

Filter by the date the number was last assigned (ISO 8601).

LastDateReleasedstring · date-timeOptional

Filter by the date the number was last released (ISO 8601).

NumberstringOptional

Filter by the actual phone number values (comma-separated).

Responses

200

A list of phone number objects.

application/json

get/Advertisers/{AccountSID}/PhoneNumbers

HTTPcURLJavaScriptPython

GET /Advertisers/{AccountSID}/PhoneNumbers HTTP/1.1
Host: api.impact.com
Authorization: Basic username:password
Accept: */*

200

A list of phone number objects.

{
  "PhoneNumbers": [
    {
      "Id": 12345,
      "Country": "US",
      "Number": "8051234567",
      "InternationalNumber": "[phone]",
      "DateCreated": "2026-01-15T10:00:00-08:00",
      "LastDateAssigned": "2026-02-01T10:00:00-08:00",
      "LastDateReleased": "2026-03-15T10:00:00-08:00",
      "Uri": "/Advertisers/<AccountSID>/PhoneNumbers/12345"
    }
  ]
}

Retrieve a PhoneNumber

get

Retrieves the details of a specific phone number using its unique identifier.

Authorizations

basicAuth

AuthorizationstringRequired

Path parameters

AccountSIDstringRequired

The unique identifier for the account.

PhoneNumberIdintegerRequired

The unique identifier for the phone number.

Responses

200

A single phone number object.

application/json

IdintegerOptional

Unique identifier for the phone number (Phone Number ID).

Example: 12345

CountrystringOptional

Two-letter ISO 3166 country code.

Example: US

NumberstringOptional

The full phone number.

Example: 8051234567

InternationalNumberstringOptional

The phone number with international prefix.

Example: [phone]

DateCreatedstring · date-time · nullableOptional

The date and time the phone number was created.

Example: 2026-01-15T10:00:00-08:00

LastDateAssignedstring · date-time · nullableOptional

The date and time the phone number was last assigned to a partner.

Example: 2026-02-01T10:00:00-08:00

LastDateReleasedstring · date-time · nullableOptional

The date and time the phone number was last released from a partner.

Example: 2026-03-15T10:00:00-08:00

Uristring · uri-referenceOptional

The URI path to this phone number object.

Example: /Advertisers/<AccountSID>/PhoneNumbers/12345

get/Advertisers/{AccountSID}/PhoneNumbers/{PhoneNumberId}

HTTPcURLJavaScriptPython

GET /Advertisers/{AccountSID}/PhoneNumbers/{PhoneNumberId} HTTP/1.1
Host: api.impact.com
Authorization: Basic username:password
Accept: */*

200

A single phone number object.

{
  "Id": 12345,
  "Country": "US",
  "Number": "8051234567",
  "InternationalNumber": "[phone]",
  "DateCreated": "2026-01-15T10:00:00-08:00",
  "LastDateAssigned": "2026-02-01T10:00:00-08:00",
  "LastDateReleased": "2026-03-15T10:00:00-08:00",
  "Uri": "/Advertisers/<AccountSID>/PhoneNumbers/12345"
}