SnippetBox

Content

JSON
Raw URL

List all collaborations

Documentation Index

Fetch the complete documentation index at: https://easybroker-staging.readme.io/llms.txt
Use this file to discover all available pages before exploring further.

List all collaborations

Returns a list of collaborations from your organization.

OpenAPI definition

{
  "openapi": "3.0.0",
  "info": {
    "version": "1.0",
    "title": "EasyBroker API",
    "description": "API for accessing and working with EasyBroker accounts. To get started click the Authorize button below and enter your API key."
  },
  "externalDocs": {
    "description": "View the getting started guide in Spanish",
    "url": "https://dev.easybroker.com/docs/api-de-easybroker"
  },
  "security": [
    {
      "ApiKeyAuth": []
    }
  ],
  "servers": [
    {
      "url": "https://api.stagingeb.com/v1",
      "description": "API URL"
    }
  ],
  "paths": {
    "/collaborations": {
      "get": {
        "tags": [
          "Collaborations"
        ],
        "summary": "List all collaborations",
        "description": "Returns a list of collaborations from your organization.",
        "parameters": [
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/limit"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful collaboration list request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CollaborationList"
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/UnauthorizedError"
          }
        }
      }
    }
  },
  "components": {
    "parameters": {
      "page": {
        "name": "page",
        "in": "query",
        "required": false,
        "description": "Content's page",
        "schema": {
          "type": "integer",
          "default": 1
        }
      },
      "limit": {
        "name": "limit",
        "in": "query",
        "required": false,
        "description": "Max results per page (Maximum: 50)",
        "schema": {
          "type": "integer",
          "maximum": 50,
          "default": 20
        }
      }
    },
    "responses": {
      "UnauthorizedError": {
        "description": "API key is missing or invalid",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "error": {
                  "type": "string",
                  "example": "Your API key is invalid"
                }
              }
            }
          }
        }
      }
    },
    "schemas": {
      "Pagination": {
        "required": [
          "limit",
          "page",
          "total,",
          "next_page"
        ],
        "properties": {
          "limit": {
            "type": "integer",
            "format": "int64",
            "maximum": 50,
            "example": 20
          },
          "page": {
            "type": "integer",
            "format": "int64",
            "example": 1
          },
          "total": {
            "type": "integer",
            "format": "int64",
            "example": 1
          },
          "next_page": {
            "type": "string",
            "example": null
          }
        }
      },
      "CollaborationList": {
        "properties": {
          "pagination": {
            "$ref": "#/components/schemas/Pagination"
          },
          "content": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CollaborationForList"
            }
          }
        }
      },
      "CollaborationForList": {
        "allOf": [
          {
            "properties": {
              "agency_id": {
                "type": "integer",
                "example": 123
              },
              "agency_name": {
                "type": "string",
                "example": "Awesome Real Estate Agency"
              },
              "group": {
                "type": "boolean",
                "example": true,
                "description": "Indicates whether this collaborator is a group or association."
              }
            }
          }
        ]
      }
    },
    "securitySchemes": {
      "ApiKeyAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "X-Authorization",
        "description": "You can find your API key in the general settings section of your EasyBroker account. It's only accessible for account administrators."
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "_id": {
    "buffer": {
      "0": 99,
      "1": 142,
      "2": 110,
      "3": 111,
      "4": 217,
      "5": 194,
      "6": 135,
      "7": 0,
      "8": 24,
      "9": 185,
      "10": 196,
      "11": 37
    }
  }
}