Blink

Blink Group API

The Group API from Blink — 2 operation(s) for group.

Documentation GitHub OpenAPI

Operations 6

GET /Groups Search or list groups #

POST /Groups Create Group #

GET /Groups/{id} Get group by id #

PUT /Groups/{id} Fully update/replace a group #

PATCH /Groups/{id} Partially update/patch a group #

DELETE /Groups/{id} Disable a group #

Specifications

⚙

OpenAPI

https://artifacts.apis.io/joinblink-com/openapi/joinblink-com-group-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

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/joinblink-com:joinblink-com-group-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:
  description: SCIM V2 API
  version: 1.0.0
  title: SCIM Group API
servers:
- url: https://api.joinblink.com/scim
security:
- ApiKeyAuth: []
tags:
- name: Group
paths:
  /Groups:
    get:
      tags:
      - Group
      summary: Search or list groups
      operationId: searchGroupViaGet
      parameters:
      - name: filter
        in: query
        description: Supports 'id', 'externalId', and 'displayName'
        required: false
        schema:
          type: string
      - name: startIndex
        in: query
        description: Start index (1-based)
        required: false
        schema:
          type: integer
          format: int32
          default: 1
      - name: count
        in: query
        description: Page size
        required: false
        schema:
          type: integer
          format: int32
          default: 100
      responses:
        '200':
          description: 'Successful operation '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupSearchResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/GroupSearchResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Authorization failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Permissions denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Too many requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    post:
      tags:
      - Group
      summary: Create Group
      operationId: createGroup
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Group'
          application/scim+json:
            schema:
              $ref: '#/components/schemas/Group'
        description: A new user without 'id'
      responses:
        '201':
          description: successfully created user
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/GroupResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Authorization failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Permissions denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: duplicate
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Too many requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /Groups/{id}:
    get:
      tags:
      - Group
      summary: Get group by id
      operationId: getGroupById
      parameters:
      - name: id
        in: path
        description: user id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: 'Successful operation '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/GroupResponse'
        '401':
          description: Authorization failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Permissions denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Too many requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    put:
      tags:
      - Group
      summary: Fully update/replace a group
      operationId: replaceGroup
      parameters:
      - name: id
        in: path
        description: Group id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Group'
          application/scim+json:
            schema:
              $ref: '#/components/schemas/Group'
        description: An existing group
      responses:
        '200':
          description: Successfully updated group
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/GroupResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Authorization failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Permissions denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: Duplicate email address or employee id
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Too many requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    patch:
      tags:
      - Group
      summary: Partially update/patch a group
      operationId: groupUser
      parameters:
      - name: id
        in: path
        description: Group id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GroupPatch'
          application/scim+json:
            schema:
              $ref: '#/components/schemas/GroupPatch'
        description: Patch operations list
      responses:
        '200':
          description: Successfully updated group
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/GroupResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Authorization failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Permissions denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: Duplicate email or employeeNumber
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Too many requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    delete:
      tags:
      - Group
      summary: Disable a group
      operationId: deleteGroup
      parameters:
      - name: id
        in: path
        description: group id
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Successfully disabled
        '401':
          description: Authorization failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Permissions denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Too many requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
            application/scim+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    PatchOperation:
      type: object
      required:
      - op
      properties:
        op:
          type: string
          enum:
          - add
          - replace
          - remove
        path:
          type: string
        value:
          type: object
          description: Corresponding 'value' of that field specified by 'path'
    ErrorResponse:
      type: object
      properties:
        detail:
          type: string
          description: Detail of error
        schemas:
          type: array
          items:
            type: string
            enum:
            - urn:ietf:params:scim:api:messages:2.0:Error
        scimType:
          type: string
          description: Bad request type when status code is 400
          enum:
          - uniqueness
          - tooMany
          - mutability
          - sensitive
          - invalidSyntax
          - invalidFilter
          - invalidPath
          - invalidValue
          - invalidVers
          - noTarget
        status:
          type: string
          description: Same as HTTP status code, e.g. 400, 401, etc.
    Group:
      type: object
      required:
      - schemas
      properties:
        externalId:
          type: string
          description: External unique resource id defined by provisioning client
        id:
          type: string
          description: Blink group id
        displayName:
          type: string
          description: Name for the group
        members:
          $ref: '#/components/schemas/GroupMember'
        schemas:
          type: array
          items:
            type: string
            enum:
            - urn:ietf:params:scim:schemas:core:2.0:Group
    GroupResponse:
      allOf:
      - $ref: '#/components/schemas/Group'
      - type: object
        properties:
          meta:
            $ref: '#/components/schemas/MetaGroup'
    GroupSearchResponse:
      type: object
      properties:
        Resources:
          type: array
          description: User list
          items:
            $ref: '#/components/schemas/GroupResponse'
        itemsPerPage:
          type: integer
          format: int64
        schemas:
          type: array
          items:
            type: string
            enum:
            - urn:ietf:params:scim:api:messages:2.0:ListResponse
        startIndex:
          type: integer
          format: int64
        totalResults:
          type: integer
          format: int64
    GroupPatch:
      type: object
      required:
      - Operations
      - schemas
      properties:
        Operations:
          type: array
          description: Patch operations list
          items:
            $ref: '#/components/schemas/PatchOperation'
        schemas:
          type: array
          items:
            type: string
            enum:
            - urn:ietf:params:scim:api:messages:2.0:PatchOp
    GroupMember:
      type: array
      description: Array of user id values
      required:
      - schemas
      items:
        type: object
        properties:
          value:
            type: string
    MetaGroup:
      type: object
      properties:
        created:
          type: string
          format: date-time
        lastModified:
          type: string
          format: date-time
        location:
          type: string
          description: Resource location URI
        resourceType:
          type: string
          enum:
          - Group
      description: Resource metadata
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
x-provenance:
  method: searched
  source: https://developer.joinblink.com/reference
  harvested: '2026-10-28'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://developer.joinblink.com/reference/creategroup.md
  - https://developer.joinblink.com/reference/createuser.md
  - https://developer.joinblink.com/reference/deletegroup.md
  - https://developer.joinblink.com/reference/deleteuser.md
  - https://developer.joinblink.com/reference/getgroupbyid.md
  - https://developer.joinblink.com/reference/getserviceproviderconfig.md
  - https://developer.joinblink.com/reference/getuserbyid.md
  - https://developer.joinblink.com/reference/groupuser.md
  - https://developer.joinblink.com/reference/patchuser.md
  - https://developer.joinblink.com/reference/replacegroup.md
  - https://developer.joinblink.com/reference/replaceuser.md
  - https://developer.joinblink.com/reference/searchgroupviaget.md
  - https://developer.joinblink.com/reference/searchviaget.md
  merge:
    pages: 13
    deduped: 72
    conflicts_kept_first: 0