EVE Online Contacts API

openapi: 3.0.0
info:
  description: An OpenAPI for EVE Online
  title: EVE Swagger Interface Alliance Contacts API
  version: '1.36'
servers:
- url: https://esi.evetech.net/latest
tags:
- name: Contacts
paths:
  /alliances/{alliance_id}/contacts/:
    get:
      description: 'Return contacts of an alliance


        ---

        Alternate route: `/dev/alliances/{alliance_id}/contacts/`


        Alternate route: `/v2/alliances/{alliance_id}/contacts/`


        ---

        This route is cached for up to 300 seconds'
      operationId: get_alliances_alliance_id_contacts
      parameters:
      - $ref: '#/components/parameters/alliance_id'
      - $ref: '#/components/parameters/datasource'
      - $ref: '#/components/parameters/If-None-Match'
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/token'
      responses:
        '200':
          description: A list of contacts
          headers:
            Cache-Control:
              description: The caching mechanism used
              schema:
                type: string
            ETag:
              description: RFC7232 compliant entity tag
              schema:
                type: string
            Expires:
              description: RFC7231 formatted datetime string
              schema:
                type: string
            Last-Modified:
              description: RFC7231 formatted datetime string
              schema:
                type: string
            X-Pages:
              description: Maximum page number
              schema:
                type: integer
                format: int32
                default: 1
          content:
            application/json:
              schema:
                description: 200 ok array
                items:
                  description: 200 ok object
                  properties:
                    contact_id:
                      description: contact_id integer
                      format: int32
                      title: get_alliances_alliance_id_contacts_contact_id
                      type: integer
                    contact_type:
                      description: contact_type string
                      enum:
                      - character
                      - corporation
                      - alliance
                      - faction
                      title: get_alliances_alliance_id_contacts_contact_type
                      type: string
                    label_ids:
                      description: label_ids array
                      items:
                        description: Label IDs applied to the contact
                        format: int64
                        title: get_alliances_alliance_id_contacts_label_id
                        type: integer
                      maxItems: 63
                      title: get_alliances_alliance_id_contacts_label_ids
                      type: array
                    standing:
                      description: Standing of the contact
                      format: float
                      title: get_alliances_alliance_id_contacts_standing
                      type: number
                  required:
                  - standing
                  - contact_type
                  - contact_id
                  title: get_alliances_alliance_id_contacts_200_ok
                  type: object
                maxItems: 1000
                title: get_alliances_alliance_id_contacts_ok
                type: array
              examples:
                response:
                  value:
                  - contact_id: 2112625428
                    contact_type: character
                    standing: 9.9
        '304':
          description: Not modified
          headers:
            Cache-Control:
              description: The caching mechanism used
              schema:
                type: string
            ETag:
              description: RFC7232 compliant entity tag
              schema:
                type: string
            Expires:
              description: RFC7231 formatted datetime string
              schema:
                type: string
            Last-Modified:
              description: RFC7231 formatted datetime string
              schema:
                type: string
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bad_request'
              examples:
                response:
                  value:
                    error: Bad request message
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/unauthorized'
              examples:
                response:
                  value:
                    error: Unauthorized message
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/forbidden'
              examples:
                response:
                  value:
                    error: Forbidden message
        '420':
          description: Error limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_limited'
              examples:
                response:
                  value:
                    error: Error limited message
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/internal_server_error'
              examples:
                response:
                  value:
                    error: Internal server error message
        '503':
          description: Service unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/service_unavailable'
              examples:
                response:
                  value:
                    error: Service unavailable message
        '504':
          description: Gateway timeout
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/gateway_timeout'
              examples:
                response:
                  value:
                    error: Gateway timeout message
      security:
      - evesso:
        - esi-alliances.read_contacts.v1
      summary: EVE Online Get Alliance Contacts
      tags:
      - Contacts
      x-alternate-versions:
      - dev
      - v2
      x-cached-seconds: 300
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /alliances/{alliance_id}/contacts/labels/:
    get:
      description: 'Return custom labels for an alliance''s contacts


        ---

        Alternate route: `/dev/alliances/{alliance_id}/contacts/labels/`


        Alternate route: `/legacy/alliances/{alliance_id}/contacts/labels/`


        Alternate route: `/v1/alliances/{alliance_id}/contacts/labels/`


        ---

        This route is cached for up to 300 seconds'
      operationId: get_alliances_alliance_id_contacts_labels
      parameters:
      - $ref: '#/components/parameters/alliance_id'
      - $ref: '#/components/parameters/datasource'
      - $ref: '#/components/parameters/If-None-Match'
      - $ref: '#/components/parameters/token'
      responses:
        '200':
          description: A list of alliance contact labels
          headers:
            Cache-Control:
              description: The caching mechanism used
              schema:
                type: string
            ETag:
              description: RFC7232 compliant entity tag
              schema:
                type: string
            Expires:
              description: RFC7231 formatted datetime string
              schema:
                type: string
            Last-Modified:
              description: RFC7231 formatted datetime string
              schema:
                type: string
          content:
            application/json:
              schema:
                description: 200 ok array
                items:
                  description: 200 ok object
                  properties:
                    label_id:
                      description: label_id integer
                      format: int64
                      title: get_alliances_alliance_id_contacts_labels_label_id
                      type: integer
                    label_name:
                      description: label_name string
                      title: get_alliances_alliance_id_contacts_labels_label_name
                      type: string
                  required:
                  - label_id
                  - label_name
                  title: get_alliances_alliance_id_contacts_labels_200_ok
                  type: object
                maxItems: 64
                title: get_alliances_alliance_id_contacts_labels_ok
                type: array
              examples:
                response:
                  value:
                  - label_id: 1
                    label_name: Alliance Friends
        '304':
          description: Not modified
          headers:
            Cache-Control:
              description: The caching mechanism used
              schema:
                type: string
            ETag:
              description: RFC7232 compliant entity tag
              schema:
                type: string
            Expires:
              description: RFC7231 formatted datetime string
              schema:
                type: string
            Last-Modified:
              description: RFC7231 formatted datetime string
              schema:
                type: string
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bad_request'
              examples:
                response:
                  value:
                    error: Bad request message
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/unauthorized'
              examples:
                response:
                  value:
                    error: Unauthorized message
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/forbidden'
              examples:
                response:
                  value:
                    error: Forbidden message
        '420':
          description: Error limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_limited'
              examples:
                response:
                  value:
                    error: Error limited message
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/internal_server_error'
              examples:
                response:
                  value:
                    error: Internal server error message
        '503':
          description: Service unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/service_unavailable'
              examples:
                response:
                  value:
                    error: Service unavailable message
        '504':
          description: Gateway timeout
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/gateway_timeout'
              examples:
                response:
                  value:
                    error: Gateway timeout message
      security:
      - evesso:
        - esi-alliances.read_contacts.v1
      summary: EVE Online Get Alliance Contact Labels
      tags:
      - Contacts
      x-alternate-versions:
      - dev
      - legacy
      - v1
      x-cached-seconds: 300
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /characters/{character_id}/contacts/:
    delete:
      description: 'Bulk delete contacts


        ---

        Alternate route: `/dev/characters/{character_id}/contacts/`


        Alternate route: `/legacy/characters/{character_id}/contacts/`


        Alternate route: `/v1/characters/{character_id}/contacts/`


        Alternate route: `/v2/characters/{character_id}/contacts/`

        '
      operationId: delete_characters_character_id_contacts
      parameters:
      - $ref: '#/components/parameters/character_id'
      - description: A list of contacts to delete
        in: query
        name: contact_ids
        required: true
        style: form
        explode: false
        schema:
          type: array
          items:
            format: int32
            type: integer
          minItems: 1
          maxItems: 20
        example:
        - 1
      - $ref: '#/components/parameters/datasource'
      - $ref: '#/components/parameters/token'
      responses:
        '204':
          description: Contacts deleted
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bad_request'
              examples:
                response:
                  value:
                    error: Bad request message
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/unauthorized'
              examples:
                response:
                  value:
                    error: Unauthorized message
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/forbidden'
              examples:
                response:
                  value:
                    error: Forbidden message
        '420':
          description: Error limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_limited'
              examples:
                response:
                  value:
                    error: Error limited message
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/internal_server_error'
              examples:
                response:
                  value:
                    error: Internal server error message
        '503':
          description: Service unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/service_unavailable'
              examples:
                response:
                  value:
                    error: Service unavailable message
        '504':
          description: Gateway timeout
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/gateway_timeout'
              examples:
                response:
                  value:
                    error: Gateway timeout message
      security:
      - evesso:
        - esi-characters.write_contacts.v1
      summary: EVE Online Delete Contacts
      tags:
      - Contacts
      x-alternate-versions:
      - dev
      - legacy
      - v1
      - v2
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    get:
      description: 'Return contacts of a character


        ---

        Alternate route: `/dev/characters/{character_id}/contacts/`


        Alternate route: `/v2/characters/{character_id}/contacts/`


        ---

        This route is cached for up to 300 seconds'
      operationId: get_characters_character_id_contacts
      parameters:
      - $ref: '#/components/parameters/character_id'
      - $ref: '#/components/parameters/datasource'
      - $ref: '#/components/parameters/If-None-Match'
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/token'
      responses:
        '200':
          description: A list of contacts
          headers:
            Cache-Control:
              description: The caching mechanism used
              schema:
                type: string
            ETag:
              description: RFC7232 compliant entity tag
              schema:
                type: string
            Expires:
              description: RFC7231 formatted datetime string
              schema:
                type: string
            Last-Modified:
              description: RFC7231 formatted datetime string
              schema:
                type: string
            X-Pages:
              description: Maximum page number
              schema:
                type: integer
                format: int32
                default: 1
          content:
            application/json:
              schema:
                description: 200 ok array
                items:
                  description: 200 ok object
                  properties:
                    contact_id:
                      description: contact_id integer
                      format: int32
                      title: get_characters_character_id_contacts_contact_id
                      type: integer
                    contact_type:
                      description: contact_type string
                      enum:
                      - character
                      - corporation
                      - alliance
                      - faction
                      title: get_characters_character_id_contacts_contact_type
                      type: string
                    is_blocked:
                      description: Whether this contact is in the blocked list. Note a missing value denotes unknown, not true or false
                      title: get_characters_character_id_contacts_is_blocked
                      type: boolean
                    is_watched:
                      description: Whether this contact is being watched
                      title: get_characters_character_id_contacts_is_watched
                      type: boolean
                    label_ids:
                      description: label_ids array
                      items:
                        description: Label IDs applied to the contact
                        format: int64
                        title: get_characters_character_id_contacts_label_id
                        type: integer
                      maxItems: 63
                      title: get_characters_character_id_contacts_label_ids
                      type: array
                    standing:
                      description: Standing of the contact
                      format: float
                      title: get_characters_character_id_contacts_standing
                      type: number
                  required:
                  - standing
                  - contact_type
                  - contact_id
                  title: get_characters_character_id_contacts_200_ok
                  type: object
                maxItems: 1024
                title: get_characters_character_id_contacts_ok
                type: array
              examples:
                response:
                  value:
                  - contact_id: 123
                    contact_type: character
                    is_blocked: true
                    is_watched: true
                    standing: 9.9
        '304':
          description: Not modified
          headers:
            Cache-Control:
              description: The caching mechanism used
              schema:
                type: string
            ETag:
              description: RFC7232 compliant entity tag
              schema:
                type: string
            Expires:
              description: RFC7231 formatted datetime string
              schema:
                type: string
            Last-Modified:
              description: RFC7231 formatted datetime string
              schema:
                type: string
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bad_request'
              examples:
                response:
                  value:
                    error: Bad request message
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/unauthorized'
              examples:
                response:
                  value:
                    error: Unauthorized message
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/forbidden'
              examples:
                response:
                  value:
                    error: Forbidden message
        '420':
          description: Error limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_limited'
              examples:
                response:
                  value:
                    error: Error limited message
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/internal_server_error'
              examples:
                response:
                  value:
                    error: Internal server error message
        '503':
          description: Service unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/service_unavailable'
              examples:
                response:
                  value:
                    error: Service unavailable message
        '504':
          description: Gateway timeout
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/gateway_timeout'
              examples:
                response:
                  value:
                    error: Gateway timeout message
      security:
      - evesso:
        - esi-characters.read_contacts.v1
      summary: EVE Online Get Contacts
      tags:
      - Contacts
      x-alternate-versions:
      - dev
      - v2
      x-cached-seconds: 300
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      description: 'Bulk add contacts with same settings


        ---

        Alternate route: `/dev/characters/{character_id}/contacts/`


        Alternate route: `/v2/characters/{character_id}/contacts/`

        '
      operationId: post_characters_character_id_contacts
      parameters:
      - $ref: '#/components/parameters/character_id'
      - $ref: '#/components/parameters/datasource'
      - description: Add custom labels to the new contact
        in: query
        name: label_ids
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            format: int64
            type: integer
          maxItems: 63
        example:
        - 1
      - description: Standing for the contact
        in: query
        name: standing
        required: true
        schema:
          type: number
          format: float
          minimum: -10
          maximum: 10
        example: 0.0
      - $ref: '#/components/parameters/token'
      - description: Whether the contact should be watched, note this is only effective on characters
        in: query
        name: watched
        required: false
        schema:
          type: boolean
          default: false
        example: false
      requestBody:
        content:
          application/json:
            schema:
              description: contact_ids array
              items:
                description: ID of the contact to edit
                format: int32
                title: post_characters_character_id_contacts_contact_id
                type: integer
              maxItems: 100
              minItems: 1
              title: post_characters_character_id_contacts_contact_ids
              type: array
            examples:
              PostCharactersCharacterIdContactsRequestExample:
                summary: Default post_characters_character_id_contacts request
                x-microcks-default: true
                value: {}
        description: A list of contacts
        required: true
      responses:
        '201':
          description: A list of contact ids that successfully created
          content:
            application/json:
              schema:
                description: 201 created array
                items:
                  description: 201 created integer
                  format: int32
                  title: post_characters_character_id_contacts_201_created
                  type: integer
                maxItems: 100
                title: post_characters_character_id_contacts_created
                type: array
              examples:
                response:
                  value:
                  - 123
                  - 456
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bad_request'
              examples:
                response:
                  value:
                    error: Bad request message
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/unauthorized'
              examples:
                response:
                  value:
                    error: Unauthorized message
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/forbidden'
              examples:
                response:
                  value:
                    error: Forbidden message
        '420':
          description: Error limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_limited'
              examples:
                response:
                  value:
                    error: Error limited message
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/internal_server_error'
              examples:
                response:
                  value:
                    error: Internal server error message
        '503':
          description: Service unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/service_unavailable'
              examples:
                response:
                  value:
                    error: Service unavailable message
        '504':
          description: Gateway timeout
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/gateway_timeout'
              examples:
                response:
                  value:
                    error: Gateway timeout message
        '520':
          description: Internal error thrown from the EVE server
          content:
            application/json:
              schema:
                description: Error 520
                properties:
                  error:
                    description: Error 520 message
                    title: post_characters_character_id_contacts_520_error_520
                    type: string
                title: post_characters_character_id_contacts_error_520
                type: object
              examples:
                response:
                  value:
                    error: Error 520 message
      security:
      - evesso:
        - esi-characters.write_contacts.v1
      summary: EVE Online Add Contacts
      tags:
      - Contacts
      x-alternate-versions:
      - dev
      - v2
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    put:
      description: 'Bulk edit contacts with same settings


        ---

        Alternate route: `/dev/characters/{character_id}/contacts/`


        Alternate route: `/v2/characters/{character_id}/contacts/`

        '
      operationId: put_characters_character_id_contacts
      parameters:
      - $ref: '#/components/parameters/character_id'
      - $ref: '#/components/parameters/datasource'
      - description: Add custom labels to the contact
        in: query
        name: label_ids
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            format: int64
            type: integer
          maxItems: 63
        example:
        - 1
      - description: Standing for the contact
        in: query
        name: standing
        required: true
        schema:
          type: number
          format: float
          minimum: -10
          maximum: 10
        example: 0.0
      - $ref: '#/components/parameters/token'
      - description: Whether the contact should be watched, note this is only effective on characters
        in: query
        name: watched
        required: false
        schema:
          type: boolean
          default: false
        example: false
      requestBody:
        content:
          application/json:
            schema:
              description: contact_ids array
              items:
                description: ID of the contact to edit
                format: int32
                title: put_characters_character_id_contacts_contact_id
                type: integer
              maxItems: 100
              minItems: 1
              title: put_characters_character_id_contacts_contact_ids
              type: array
            examples:
              PutCharactersCharacterIdContactsRequestExample:
                summary: Default put_characters_character_id_contacts request
                x-microcks-default: true
                value: {}
        description: A list of contacts
        required: true
      responses:
        '204':
          description: Contacts updated
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bad_request'
              examples:
                response:
                  value:
                    error: Bad request message
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/unauthorized'
              examples:
                response:
                  value:
                    error: Unauthorized message
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/forbidden'
              examples:
                response:
                  value:
                    error: Forbidden message
        '420':
          description: Error limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_limited'
              examples:
                response:
                  value:
                    error: Error limited message
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/internal_server_error'
              examples:
                response:
                  value:
                    error: Internal server error message
        '503':
          description: Service unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/service_unavailable'
              examples:
                response:
                  value:
                    error: Service unavailable message
        '504':
          description: Gateway timeout
          

# --- truncated at 32 KB (99 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/eve-online/refs/heads/main/openapi/eve-online-contacts-api-openapi.yml