Get Cities

Description

This service provides access to all cities associated with a specific state.


Request

Endpoint

GET https://<server-url>/api/v4/referencedata/states/{stateId}/cities

Path Parameters

Parameter
Type
Description

stateId

Integer

The unique identifier of the state for which to retrieve the cities. To get this identifier, please see the Get States/Provinces method.

Parameters

Parameter
Location
Description

touchpoint

Query / Header

The identifier for the touchpoint making the request. If sent as a header, the name must be Thalamus-Touchpoint.

token

Query / Header

The authentication token for the API. If sent as a header, the name must be Thalamus-Token.

Content-Type

Header

Specifies the content type of the request body. Must be application/json.

Full URL Example

http://localhost:8080/thalamus/api/v4/referencedata/states/1/cities?touchpoint=test&token=testtesttesttesttesttesttesttesttesttesttesttesttesttesttesttest

Request Body

This request does not have a body.


Response

✅ Successful Response: 200 OK

A JSON array of city objects is returned for the specified state.

Field
Type
Description

name

String

The name of the city.

id

Number

The unique identifier for the city.

stateId

Number

The identifier of the associated state.

JSON

Last updated

Was this helpful?