find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/zype:zype-custom-regions-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Custom Regions API
  version: 1.0.0
  description: Site-scoped **Custom Regions** and the read-only **Global Content Regions** catalog.
servers:
- url: https://api.zype.com/
security:
- api_key: []
tags:
- name: Custom Regions
  description: CRUD for custom country groupings on the current site.
paths:
  /v3/content_regions:
    get:
      tags:
      - Custom Regions
      summary: List content regions
      description: Retrieve custom content regions (country groupings) for the current site.
      operationId: listContentRegions
      parameters: []
      responses:
        '200':
          description: Response will contain an array of content regions, ordered by name.
          content:
            application/json:
              schema:
                title: ContentRegionsResponse
                type: object
                properties:
                  response:
                    type: array
                    items:
                      $ref: '#/paths/~1v3~1content_regions/post/responses/201/content/application~1json/schema/properties/response'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                title: NotFound
                type: object
                required:
                - message
                properties:
                  message:
                    type: string
    post:
      tags:
      - Custom Regions
      summary: Create Content region
      description: Create a custom content region for the current site.
      operationId: createContentRegion
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              title: ContentRegionRequest
              type: object
              required:
              - content_region
              properties:
                content_region:
                  title: ContentRegionProperties
                  type: object
                  properties:
                    name:
                      type: string
                    country_codes:
                      type: array
                      items:
                        type: string
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                title: ContentRegionResponse
                type: object
                properties:
                  response:
                    title: ContentRegion
                    type: object
                    properties:
                      _id:
                        type: string
                      name:
                        type: string
                      country_codes:
                        type: array
                        description: ISO 3166-1 alpha-2 country codes (uppercase). Empty strings are stripped and values are normalized on save.
                        items:
                          type: string
                      created_at:
                        type: string
                      updated_at:
                        type: string
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/paths/~1v3~1content_regions/get/responses/403/content/application~1json/schema'
        '422':
          description: Unprocessable entity
          content:
            application/json:
              schema:
                title: Unprocessable Entity
                type: object
                properties:
                  message:
                    type: string
  /v3/content_regions/{id}:
    get:
      tags:
      - Custom Regions
      summary: View Content Region
      description: Retrieve a single content region from the current site.
      operationId: getContentRegion
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: ID of the content region.
      responses:
        '200':
          description: Return content region.
          content:
            application/json:
              schema:
                $ref: '#/paths/~1v3~1content_regions/post/responses/201/content/application~1json/schema'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/paths/~1v3~1content_regions/get/responses/403/content/application~1json/schema'
        '404':
          description: Content region not found
          content:
            application/json:
              schema:
                $ref: '#/paths/~1v3~1content_regions/get/responses/403/content/application~1json/schema'
    put:
      tags:
      - Custom Regions
      summary: Update Content Region
      description: Update a content region for the current site.
      operationId: updateContentRegion
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: ID of the content region.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/paths/~1v3~1content_regions/post/requestBody/content/application~1json/schema'
      responses:
        '200':
          description: Updated content region.
          content:
            application/json:
              schema:
                $ref: '#/paths/~1v3~1content_regions/post/responses/201/content/application~1json/schema'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/paths/~1v3~1content_regions/get/responses/403/content/application~1json/schema'
        '404':
          description: Content region not found
          content:
            application/json:
              schema:
                $ref: '#/paths/~1v3~1content_regions/get/responses/403/content/application~1json/schema'
        '422':
          description: Unprocessable entity
          content:
            application/json:
              schema:
                $ref: '#/paths/~1v3~1content_regions/post/responses/422/content/application~1json/schema'
    delete:
      tags:
      - Custom Regions
      summary: Delete Content Region
      description: Delete a content region from the current site.
      operationId: deleteContentRegion
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: ID of the content region.
      responses:
        '204':
          description: Content region deleted successfully.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/paths/~1v3~1content_regions/get/responses/403/content/application~1json/schema'
        '404':
          description: Content region not found
          content:
            application/json:
              schema:
                $ref: '#/paths/~1v3~1content_regions/get/responses/403/content/application~1json/schema'
        '422':
          description: Unprocessable entity
          content:
            application/json:
              schema:
                $ref: '#/paths/~1v3~1content_regions/post/responses/422/content/application~1json/schema'
components:
  securitySchemes:
    api_key:
      type: apiKey
      name: api_key
      in: query
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: OAuth access token
      description: OAuth access token of the consumer