Skip to main content

Retrieve a number search



Retrieves the details of an existing number search. Searches expire 15 minutes after creation. Once expired they can no longer be used to create an order.

Searches may include best effort matches in the results. These are numbers that are close to your search terms, but may not be exact matches. Best effort matches will come after exact matches in the results and can be easily distinguished by the value of best_effort being true.

The top-level key any_best_effort is also an indicator of whether there are best effort matches present in the results."


Path Parameters

    id stringrequired

    ID of the number search to retrieve


200: number


    id stringrequired
    search_type integerrequired

    Default value: 1

    NPA/NXX = 1, Region = 2, Tollfree = 3, Advanced = 4

    limit integerrequired

    Default value: 10

    search_descriptor objectrequired
    status integerrequired

    Default value: 1

    Pending = 1, Complete = 2

    any_best_effort booleanrequired

    Default value: false

    Indicator of whether there are any best effort matches present or not

    result object[]required

401: Unauthorized

404: Resource not found