Agents

Get Agent

Get agent by ID — requires agents:read or self-read.

get/agents/{agent_id}

Path parameters

agent_idstring required

Response

Successful Response

approved_atstring date-time nullable
approved_bystring nullable
created_atstring date-time required
denial_reasonstring nullable
denied_bystring nullable
descriptionstring nullable
has_api_keyboolean
idstring required
namestring required
owner_idstring nullable
parent_agent_idstring nullable
registered_bystring required
statusstring required

Changes

Changed in 3 of the 85 revisions of this API.339

  • d65fcba0d25a238See the full diff
    • the response's body type/format changed from / to object/ for status 200

      response-body-type-changed

    • the detail response's property type/format changed from array/ to string/ for status 422

      response-property-type-changed

    • api operation id get_agent_agents__agent_id__get removed and replaced with getAgent

      api-operation-id-removed

    • the endpoint scheme security BearerAuth was added to the API

      api-security-added

    • the endpoint scheme security HumanLogin was removed from the API

      api-security-removed

    • api tag Agents added

      api-tag-added

    • api tag agents removed

      api-tag-removed

    • media type application/json was changed to a more specific media type application/problem+json for the response status 403

      response-media-type-name-specialized

    • media type application/json was changed to a more specific media type application/problem+json for the response status 422

      response-media-type-name-specialized

    • added the non-success response with the status 400

      response-non-success-status-added

    • added the non-success response with the status 401

      response-non-success-status-added

    • added the non-success response with the status 500

      response-non-success-status-added

    • added the non-success response with the status 503

      response-non-success-status-added

    • removed the non-success response with the status 404

      response-non-success-status-removed

    • added the optional property approved_at to the response with the 200 status

      response-optional-property-added

    • added the optional property approved_by to the response with the 200 status

      response-optional-property-added

    • added the optional property code to the response with the 403 status

      response-optional-property-added

    • added the optional property code to the response with the 422 status

      response-optional-property-added

    • added the optional property denial_reason to the response with the 200 status

      response-optional-property-added

    • added the optional property denied_by to the response with the 200 status

      response-optional-property-added

    • added the optional property description to the response with the 200 status

      response-optional-property-added

    • added the optional property errors to the response with the 403 status

      response-optional-property-added

    • added the optional property errors to the response with the 422 status

      response-optional-property-added

    • added the optional property has_api_key to the response with the 200 status

      response-optional-property-added

    • added the optional property instance to the response with the 403 status

      response-optional-property-added

    • added the optional property instance to the response with the 422 status

      response-optional-property-added

    • added the optional property owner_id to the response with the 200 status

      response-optional-property-added

    • added the optional property parent_agent_id to the response with the 200 status

      response-optional-property-added

    • added the optional property status to the response with the 403 status

      response-optional-property-added

    • added the optional property status to the response with the 422 status

      response-optional-property-added

    • added the optional property title to the response with the 403 status

      response-optional-property-added

    • added the optional property title to the response with the 422 status

      response-optional-property-added

    • added the optional property type to the response with the 403 status

      response-optional-property-added

    • added the optional property type to the response with the 422 status

      response-optional-property-added

    • the response property detail became required for the status 422

      response-property-became-required

    • added the required property created_at to the response with the 200 status

      response-required-property-added

    • added the required property id to the response with the 200 status

      response-required-property-added

    • added the required property name to the response with the 200 status

      response-required-property-added

    • added the required property registered_by to the response with the 200 status

      response-required-property-added

    • added the required property status to the response with the 200 status

      response-required-property-added

    This revision also has 61 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • endpoint added

      endpoint-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 179 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog