API documentation

GET /number_orders

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/number_orders

List Number Orders.

Lists Number Orders, which are requests to purchase new tracking numbers and assign them to an offer, schedule, traffic source, or number pool.

Params

Param name	Description
ids Optional	Return records matching these ids. Must be an array of decimal values. EG: `[0, 1, 2, 3]`
page Optional	Return the next page of results. Must be a number.
per_page Optional	How many results to return per page. The default is 25. Must be a number.
created_at_to Optional	Date formatted like 2016-01-01 12:25:15 -0500 Must be a String
created_at_from Optional	Date formatted like 2016-01-01 12:25:15 -0500 Must be a String
fulltext Optional	Search for any record that matches this text Must be a String
time_zone Optional	Date ranges will be parsed using this time zone. Must be a valid time zone. See the list of valid time zones.
columns Optional	Specify the columns you would like returned by the API for a given resource. Limiting the columns can significantly increase API response time since only the requested data will be processed. columns=uuid,number,created_at Must be any combination of: id legacy_id type uuid created_at updated_at deleted_at user_updated_at routes_show_path routes_edit_path external_record_id paused offer_id ring_pool_id traffic_source_id schedule_id name description provider_configuration_id numbers_count fallback_to_any_number_in_state number_order_prefix_ids Must be a String
root Optional	Pass `root=false` to return results without a root node and metadata. For example: `GET /api/v1/calls?root=false` will return `[call1, call2, call3]` While: `GET /api/v1/calls` will return `{calls: [call1, call2, call3], metadata: {}}` Must be a boolean value: 1, true, yes, on, 0, false, no, off

Example Request

curl 'https://[your-subdomain].trackdrive.com/api/v1/number_orders/?per_page=2' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "number_orders": [
    {
      "id": 10001,
      "type": "NumberOrder",
      "uuid": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
      "created_at": "2026-01-15T15:30:00.000Z",
      "updated_at": "2026-01-15T15:30:00.000Z",
      "deleted_at": null,
      "user_updated_at": null,
      "routes_show_path": "/number_orders/10001",
      "routes_edit_path": "/number_orders/10001/edit",
      "external_record_id": null,
      "paused": true,
      "offer_id": 10002,
      "ring_pool_id": null,
      "traffic_source_id": null,
      "schedule_id": null,
      "name": "New York Metro Expansion",
      "description": "Seeded for the number_orders/number_order_prefixes API docs examples",
      "provider_configuration_id": 10003,
      "numbers_count": null,
      "fallback_to_any_number_in_state": null,
      "number_order_prefix_ids": [
        10004
      ]
    }
  ],
  "metadata": {
    "root": "number_orders",
    "page": 1,
    "total_pages": 1,
    "per_page": 2,
    "total_count": 1,
    "next_cursor": 10005
  }
}

GET /number_orders/new

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/number_orders/new

Build Number Order with defaults.

Builds a Number Order with default attributes without saving it.

Params

Param name	Description
offer_id Optional Blank value allowed	The offer the ordered numbers will be assigned to. Must be a valid foreign key reference to an Offer. Refer to: /api/docs/1.0/offers
ring_pool_id Optional Blank value allowed	The number pool the ordered numbers will be added to. Must be a valid foreign key reference to an Number Pool. Refer to: /api/docs/1.0/ring_pools
traffic_source_id Optional Blank value allowed	The traffic source the ordered numbers will be assigned to. Must be a valid foreign key reference to an Traffic Source. Refer to: /api/docs/1.0/traffic_sources
schedule_id Optional Blank value allowed	The schedule the ordered numbers will be assigned to. Must be a valid foreign key reference to an Schedule. Refer to: /api/docs/1.0/schedules
name Optional Blank value allowed	The name of the number order. Must be a String
description Optional Blank value allowed	A description of the number order. Must be a String
provider_configuration_id Optional Blank value allowed	The provider the numbers will be purchased from. Must be a valid foreign key reference to an Provider. Refer to: /api/docs/1.0/provider_configurations
paused Optional Blank value allowed	Pause the order so it stops purchasing numbers. Must be a boolean value: 1, true, yes, on, 0, false, no, off
fallback_to_any_number_in_state Optional Blank value allowed	When no number is available with the requested prefix, allow purchasing any available number in the same state. Must be a boolean value: 1, true, yes, on, 0, false, no, off

Example Request

curl 'https://[your-subdomain].trackdrive.com/api/v1/number_orders/new' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "number_order": {
    "id": null,
    "type": "NumberOrder",
    "uuid": null,
    "created_at": null,
    "updated_at": null,
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/number_orders/new",
    "routes_edit_path": "/number_orders/new",
    "external_record_id": null,
    "paused": null,
    "offer_id": null,
    "ring_pool_id": null,
    "traffic_source_id": null,
    "schedule_id": null,
    "name": "Order By 1 person1@example.com At 2026-09-24",
    "description": null,
    "provider_configuration_id": 10001,
    "numbers_count": null,
    "fallback_to_any_number_in_state": null,
    "number_order_prefix_ids": []
  },
  "metadata": {
    "root": "number_order"
  }
}

POST /number_orders

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/number_orders

Create Number Order.

Creates a Number Order to purchase numbers from the given provider configuration for an offer. Numbers are provisioned asynchronously after the order is created, and only proceed once the company is verified and can afford the numbers being purchased.

Params

Param name	Description
offer_id Optional Blank value allowed	The offer the ordered numbers will be assigned to. Must be a valid foreign key reference to an Offer. Refer to: /api/docs/1.0/offers
ring_pool_id Optional Blank value allowed	The number pool the ordered numbers will be added to. Must be a valid foreign key reference to an Number Pool. Refer to: /api/docs/1.0/ring_pools
traffic_source_id Optional Blank value allowed	The traffic source the ordered numbers will be assigned to. Must be a valid foreign key reference to an Traffic Source. Refer to: /api/docs/1.0/traffic_sources
schedule_id Optional Blank value allowed	The schedule the ordered numbers will be assigned to. Must be a valid foreign key reference to an Schedule. Refer to: /api/docs/1.0/schedules
name Optional Blank value allowed	The name of the number order. Must be a String
description Optional Blank value allowed	A description of the number order. Must be a String
provider_configuration_id Optional Blank value allowed	The provider the numbers will be purchased from. Must be a valid foreign key reference to an Provider. Refer to: /api/docs/1.0/provider_configurations
paused Optional Blank value allowed	Pause the order so it stops purchasing numbers. Must be a boolean value: 1, true, yes, on, 0, false, no, off
fallback_to_any_number_in_state Optional Blank value allowed	When no number is available with the requested prefix, allow purchasing any available number in the same state. Must be a boolean value: 1, true, yes, on, 0, false, no, off

Example Request

curl -X POST 'https://[your-subdomain].trackdrive.com/api/v1/number_orders/' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Example Number Order",
  "offer_id": 10002,
  "provider_configuration_id": 10001
}'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "number_order": {
    "id": 10001,
    "type": "NumberOrder",
    "uuid": "a0d49c48-1b1e-4760-ac0d-da771aa599db",
    "created_at": "2026-01-15T15:30:00.000Z",
    "updated_at": "2026-01-15T15:30:00.000Z",
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/number_orders/10001",
    "routes_edit_path": "/number_orders/10001/edit",
    "external_record_id": null,
    "paused": true,
    "offer_id": 10002,
    "ring_pool_id": null,
    "traffic_source_id": null,
    "schedule_id": null,
    "name": "Example Number Order",
    "description": null,
    "provider_configuration_id": 10001,
    "numbers_count": null,
    "fallback_to_any_number_in_state": null,
    "number_order_prefix_ids": []
  },
  "metadata": {
    "root": "number_order"
  }
}

GET /number_orders/:id

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/number_orders/:id

Get Number Order by id.

Gets a Number Order's details by id.

Example Request

curl 'https://[your-subdomain].trackdrive.com/api/v1/number_orders/10001' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "number_order": {
    "id": 10001,
    "type": "NumberOrder",
    "uuid": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "created_at": "2026-01-15T15:30:00.000Z",
    "updated_at": "2026-01-15T15:30:00.000Z",
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/number_orders/10001",
    "routes_edit_path": "/number_orders/10001/edit",
    "external_record_id": null,
    "paused": true,
    "offer_id": 10002,
    "ring_pool_id": null,
    "traffic_source_id": null,
    "schedule_id": null,
    "name": "New York Metro Expansion",
    "description": "Seeded for the number_orders/number_order_prefixes API docs examples",
    "provider_configuration_id": 10003,
    "numbers_count": null,
    "fallback_to_any_number_in_state": null,
    "number_order_prefix_ids": [
      10004
    ]
  },
  "metadata": {
    "root": "number_order"
  }
}

PUT /number_orders/:id

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/number_orders/:id

Update Number Order by id.

Updates a Number Order's name, description, pause state, or the offer, schedule, traffic source, or number pool it is assigned to.

Params

Param name	Description
offer_id Optional Blank value allowed	The offer the ordered numbers will be assigned to. Must be a valid foreign key reference to an Offer. Refer to: /api/docs/1.0/offers
ring_pool_id Optional Blank value allowed	The number pool the ordered numbers will be added to. Must be a valid foreign key reference to an Number Pool. Refer to: /api/docs/1.0/ring_pools
traffic_source_id Optional Blank value allowed	The traffic source the ordered numbers will be assigned to. Must be a valid foreign key reference to an Traffic Source. Refer to: /api/docs/1.0/traffic_sources
schedule_id Optional Blank value allowed	The schedule the ordered numbers will be assigned to. Must be a valid foreign key reference to an Schedule. Refer to: /api/docs/1.0/schedules
name Optional Blank value allowed	The name of the number order. Must be a String
description Optional Blank value allowed	A description of the number order. Must be a String
provider_configuration_id Optional Blank value allowed	The provider the numbers will be purchased from. Must be a valid foreign key reference to an Provider. Refer to: /api/docs/1.0/provider_configurations
paused Optional Blank value allowed	Pause the order so it stops purchasing numbers. Must be a boolean value: 1, true, yes, on, 0, false, no, off
fallback_to_any_number_in_state Optional Blank value allowed	When no number is available with the requested prefix, allow purchasing any available number in the same state. Must be a boolean value: 1, true, yes, on, 0, false, no, off

Example Request

curl -X PUT 'https://[your-subdomain].trackdrive.com/api/v1/number_orders/10001' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "description": "Numbers for the spring campaign"
}'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "number_order": {
    "id": 10001,
    "type": "NumberOrder",
    "uuid": "a0d49c48-1b1e-4760-ac0d-da771aa599db",
    "created_at": "2026-01-15T15:30:00.000Z",
    "updated_at": "2026-01-15T15:30:00.000Z",
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/number_orders/10001",
    "routes_edit_path": "/number_orders/10001/edit",
    "external_record_id": null,
    "paused": true,
    "offer_id": 10002,
    "ring_pool_id": null,
    "traffic_source_id": null,
    "schedule_id": null,
    "name": "Example Number Order",
    "description": "Numbers for the spring campaign",
    "provider_configuration_id": 10001,
    "numbers_count": 0,
    "fallback_to_any_number_in_state": null,
    "number_order_prefix_ids": [
      10001
    ]
  },
  "metadata": {
    "root": "number_order"
  }
}

DELETE /number_orders/:id

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/number_orders/:id

Destroy Number Order by id.

Deletes a Number Order by id.

Example Request

curl -X DELETE 'https://[your-subdomain].trackdrive.com/api/v1/number_orders/10001' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "number_order": {
    "id": 10001,
    "type": "NumberOrder",
    "uuid": "a0d49c48-1b1e-4760-ac0d-da771aa599db",
    "created_at": "2026-01-15T15:30:00.000Z",
    "updated_at": "2026-01-15T15:30:00.000Z",
    "deleted_at": "2026-01-15T15:30:00.000Z",
    "user_updated_at": null,
    "routes_show_path": "/number_orders/10001",
    "routes_edit_path": "/number_orders/10001/edit",
    "external_record_id": null,
    "paused": true,
    "offer_id": 10002,
    "ring_pool_id": null,
    "traffic_source_id": null,
    "schedule_id": null,
    "name": "Example Number Order",
    "description": null,
    "provider_configuration_id": 10001,
    "numbers_count": 0,
    "fallback_to_any_number_in_state": null,
    "number_order_prefix_ids": []
  },
  "metadata": {
    "root": "number_order"
  }
}

Params

Must be any combination of:

Params

Params

Params