API documentation

GET /number_order_prefixes

Authorization Required

https://[your-subdomain].trackdrive.net/api/v1/number_order_prefixes

List Number Order Prefix records.

Lists the Number Order Prefix entries attached to number orders, each specifying a prefix pattern and how many numbers to purchase matching it.

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 number_order_id prefix order_count numbers_statuses number_ids sortable_order 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.net/api/v1/number_order_prefixes/?per_page=2' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "number_order_prefixes": [
    {
      "id": 10001,
      "type": "NumberOrderPrefix",
      "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_order_prefixes/10001",
      "routes_edit_path": "/number_order_prefixes/10001/edit",
      "external_record_id": null,
      "number_order_id": 10002,
      "prefix": "212",
      "order_count": 1,
      "numbers_statuses": [
        {
          "status": "pending",
          "name": "Pending",
          "count": 1,
          "error_reason": null,
          "numbers": []
        }
      ],
      "number_ids": [],
      "sortable_order": 1
    }
  ],
  "metadata": {
    "root": "number_order_prefixes",
    "page": 1,
    "total_pages": 1,
    "per_page": 2,
    "total_count": 1,
    "next_cursor": 10003
  }
}

GET /number_order_prefixes/new

Authorization Required

https://[your-subdomain].trackdrive.net/api/v1/number_order_prefixes/new

Build Number Order Prefix with defaults.

Returns a blank Number Order Prefix populated with default attribute values, without saving it.

Params

Param name	Description
number_order_id Optional Blank value allowed	Number Order Must be a valid foreign key reference to an Number Order. Refer to: /api/docs/1.0/number_orders
prefix Optional Blank value allowed	Prefix Must be a String
order_count Optional Blank value allowed	Order Count Must be a decimal number.
sortable_order Optional Blank value allowed	Sortable Order Must be a decimal number.

Example Request

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

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "number_order_prefix": {
    "id": null,
    "type": "NumberOrderPrefix",
    "uuid": null,
    "created_at": null,
    "updated_at": null,
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/number_order_prefixes/new",
    "routes_edit_path": "/number_order_prefixes/new",
    "external_record_id": null,
    "number_order_id": null,
    "prefix": "1855",
    "order_count": 1,
    "numbers_statuses": [
      {
        "status": "pending",
        "name": "Pending",
        "count": 1,
        "error_reason": null,
        "numbers": []
      }
    ],
    "number_ids": [],
    "sortable_order": null
  },
  "metadata": {
    "root": "number_order_prefix"
  }
}

POST /number_order_prefixes

Authorization Required

https://[your-subdomain].trackdrive.net/api/v1/number_order_prefixes

Create Number Order Prefix.

Creates a Number Order Prefix under a number order, requesting order_count numbers (1 to 100) matching the given prefix. The prefix must be unique within its number order.

Params

Param name	Description
number_order_id Optional Blank value allowed	Number Order Must be a valid foreign key reference to an Number Order. Refer to: /api/docs/1.0/number_orders
prefix Optional Blank value allowed	Prefix Must be a String
order_count Optional Blank value allowed	Order Count Must be a decimal number.
sortable_order Optional Blank value allowed	Sortable Order Must be a decimal number.

Example Request

curl -X POST 'https://[your-subdomain].trackdrive.net/api/v1/number_order_prefixes/' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "number_order_id": 10001,
  "prefix": "212",
  "order_count": 1
}'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "number_order_prefix": {
    "id": 10001,
    "type": "NumberOrderPrefix",
    "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_order_prefixes/10001",
    "routes_edit_path": "/number_order_prefixes/10001/edit",
    "external_record_id": null,
    "number_order_id": 10001,
    "prefix": "212",
    "order_count": 1,
    "numbers_statuses": [
      {
        "status": "pending",
        "name": "Pending",
        "count": 1,
        "error_reason": null,
        "numbers": []
      }
    ],
    "number_ids": [],
    "sortable_order": 1
  },
  "metadata": {
    "root": "number_order_prefix"
  }
}

GET /number_order_prefixes/:id

Authorization Required

https://[your-subdomain].trackdrive.net/api/v1/number_order_prefixes/:id

Get Number Order Prefix by id.

Fetches a single Number Order Prefix by id.

Example Request

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

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "number_order_prefix": {
    "id": 10001,
    "type": "NumberOrderPrefix",
    "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_order_prefixes/10001",
    "routes_edit_path": "/number_order_prefixes/10001/edit",
    "external_record_id": null,
    "number_order_id": 10002,
    "prefix": "212",
    "order_count": 1,
    "numbers_statuses": [
      {
        "status": "pending",
        "name": "Pending",
        "count": 1,
        "error_reason": null,
        "numbers": []
      }
    ],
    "number_ids": [],
    "sortable_order": 1
  },
  "metadata": {
    "root": "number_order_prefix"
  }
}

PUT /number_order_prefixes/:id

Authorization Required

https://[your-subdomain].trackdrive.net/api/v1/number_order_prefixes/:id

Update Number Order Prefix by id.

Updates a Number Order Prefix's prefix pattern, order count, or sort order.

Params

Param name	Description
number_order_id Optional Blank value allowed	Number Order Must be a valid foreign key reference to an Number Order. Refer to: /api/docs/1.0/number_orders
prefix Optional Blank value allowed	Prefix Must be a String
order_count Optional Blank value allowed	Order Count Must be a decimal number.
sortable_order Optional Blank value allowed	Sortable Order Must be a decimal number.

Example Request

curl -X PUT 'https://[your-subdomain].trackdrive.net/api/v1/number_order_prefixes/10001' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "order_count": 2
}'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "number_order_prefix": {
    "id": 10001,
    "type": "NumberOrderPrefix",
    "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_order_prefixes/10001",
    "routes_edit_path": "/number_order_prefixes/10001/edit",
    "external_record_id": null,
    "number_order_id": 10001,
    "prefix": "212",
    "order_count": 2,
    "numbers_statuses": [
      {
        "status": "pending",
        "name": "Pending",
        "count": 2,
        "error_reason": null,
        "numbers": []
      }
    ],
    "number_ids": [],
    "sortable_order": 1
  },
  "metadata": {
    "root": "number_order_prefix"
  }
}

DELETE /number_order_prefixes/:id

Authorization Required

https://[your-subdomain].trackdrive.net/api/v1/number_order_prefixes/:id

Destroy Number Order Prefix by id.

Deletes a Number Order Prefix by id.

Example Request

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

Example Response 204

Params

Must be any combination of:

Params

Params

Params