Find places

GET

/api/v1/leads/places

curl --request GET \
  --url 'https://digize.com/api/v1/leads/places?q=example' \
  --header 'x-api-key: <x-api-key>'

• Digize

ZIP codes, cities and counties LeadsPlease knows whose name or number starts with q.

Needs the crm:read permission.

Authorizations

• apiKey
• bearer

Parameters

Query Parameters

q

required

string

>= 2 characters <= 60 characters

Responses

200

Done

Media typeapplication/json

object

data

required

Array<object>

object

type

required

string

Allowed values: zip city county state

name

required

string

state

required

string | null

label

required

string

lat

required

number

lng

required

number

Example

{
  "data": [
    {
      "type": "zip"
    }
  ]
}

400

What was sent isn’t valid (invalid).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

401

No key, or one that’s unknown, off or expired.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

403

The key doesn’t have the permission this needs.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

404

Nothing has that id (not_found).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

429

Over the rate limit; see retry-after.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}