Countries

Retrieve Country

get

Retrieve a specific Country by ID

Authorizations
AuthorizationstringRequired
Path parameters
idintegerRequired

Unique identifier of the resource

Example: 1
Responses
200

Country retrieved successfully

application/json
get
/api/v1/countries/{id}/

Update Country

put

Update a specific Country by ID

Authorizations
AuthorizationstringRequired
Path parameters
idintegerRequired

Unique identifier of the resource

Example: 1
Body
idintegerRead-onlyOptional

Country ID

namestringRequired

Country Name

Example: Türkiye
codestringRequired

Country Code

Example: TR
is_activebooleanOptional

Is Active (true/false)

Example: true
created_datestring · date-timeRead-onlyOptional

Created Date

Example: 2021-07-07T14:00:00Z
modified_datestring · date-timeRead-onlyOptional

Modified Date

Example: 2021-07-07T14:00:00Z
Responses
200

Country updated

No content

put
/api/v1/countries/{id}/

No content

Delete Country

delete

Delete a specific Country by ID

Authorizations
AuthorizationstringRequired
Path parameters
idintegerRequired

Unique identifier of the resource

Example: 1
Responses
delete
/api/v1/countries/{id}/

No content

Partial Update Country

patch

Partial update a specific Country by ID

Authorizations
AuthorizationstringRequired
Path parameters
idintegerRequired

Unique identifier of the resource

Example: 1
Body
idintegerRead-onlyOptional

Country ID

namestringRequired

Country Name

Example: Türkiye
codestringRequired

Country Code

Example: TR
is_activebooleanOptional

Is Active (true/false)

Example: true
created_datestring · date-timeRead-onlyOptional

Created Date

Example: 2021-07-07T14:00:00Z
modified_datestring · date-timeRead-onlyOptional

Modified Date

Example: 2021-07-07T14:00:00Z
Responses
200

Country updated

No content

patch
/api/v1/countries/{id}/

No content

Retrieve Country with details

get

Retrieve a specific Country by ID with details

Authorizations
AuthorizationstringRequired
Path parameters
idintegerRequired

Unique identifier of the resource

Example: 1
Responses
200

Country retrieved successfully with details

application/json
get
/api/v1/countries/{id}/detailed/

List Countries

get

List Countries

Authorizations
AuthorizationstringRequired
Query parameters
pageinteger · min: 1Optional

Specifies the page number of the current dataset

Default: 1
limitinteger · min: 1Optional

Indicates the number of rows on the current page.

Default: 10
name__exactstringOptional

Filters by exact name

code__exactstringOptional

Filters by exact code

mapping__integration_typestring · enumOptional

Filter by integration mapping object's integration type

Possible values:
mapping__code__exactstringOptional

Filter by integration mapping object's code

hyperbooleanOptional

Activate id to hyperlink the response data.

Responses
200

OK

application/json
get
/api/v1/countries/

Create Country

post

Create Country

Authorizations
AuthorizationstringRequired
Body
idintegerRead-onlyOptional

Country ID

namestringRequired

Country Name

Example: Türkiye
codestringRequired

Country Code

Example: TR
is_activebooleanOptional

Is Active (true/false)

Example: true
created_datestring · date-timeRead-onlyOptional

Created Date

Example: 2021-07-07T14:00:00Z
modified_datestring · date-timeRead-onlyOptional

Modified Date

Example: 2021-07-07T14:00:00Z
Responses
post
/api/v1/countries/

List Countries with details

get

List Countries with details

Authorizations
AuthorizationstringRequired
Query parameters
pageinteger · min: 1Optional

Specifies the page number of the current dataset

Default: 1
limitinteger · min: 1Optional

Indicates the number of rows on the current page.

Default: 10
name__exactstringOptional

Filters by exact name

code__exactstringOptional

Filters by exact code

mapping__integration_typestring · enumOptional

Filter by integration mapping object's integration type

Possible values:
mapping__code__exactstringOptional

Filter by integration mapping object's code

hyperbooleanOptional

Activate id to hyperlink the response data.

Responses
200

OK

application/json
get
/api/v1/countries/detailed/

Was this helpful?