API Documentation - fetchdocs

Create a new connection by migrating it from your application to fetchdocs. This endpoint creates a new connection and stores the credentials at fetchdocs. If the integration requires OAuth, the connection is created in status INVALID_CREDENTIALS. A startdate sent in fields is ignored: migrated connections always get the migration date as startdate, so only documents created on or after the migration are fetched.

🔐 Authentication

X-API-KEY API key of the environment

Header parameter: X-API-KEY

📤 Request

Content Type: application/json

identity_uuid string required uuid

The UUID of the identity the connection should be created for.

Example: 81c4de7f-cdba-4f45-ba2c-dd8060fde7e5

integration_id string required

The ID of the integration the connection should be created for.

Example: aws_s3

name string required

The name of the connection. Can later be shown to the user.

Example: My Connection

fields object required

The fields required by the integration. The fields are dynamic and depend on the integration. The fields are validated by the integration itself.

Example: { "secret_id": "mustermann", "secret_key": "123456" }

Request Example

{
    "identity_uuid": "81c4de7f-cdba-4f45-ba2c-dd8060fde7e5",
    "integration_id": "aws_s3",
    "name": "My Connection",
    "fields": {
        "secret_id": "mustermann",
        "secret_key": "123456"
    }
}
            

📥 Response

201 Created

Content Type:

data object

object

uuid string

The UUID of the migrated connection.

Example: 3598b23c-31db-4be9-9e6b-6aa1d5b60335

401 Unauthorized Error

Content Type:

The error response is returned when the client is not authenticated. The client must provide a valid authentication key to access the resource.

error string

The error code is a machine readable code describing the error.

Example: API_KEY_MISSING_OR_INVALID

message string

The error message is a human readable message describing the error. It is mainly used for understanding the error by developers. It is not meant to be shown to real users.

Example: API key is missing or invalid.

suggestion string

For many errors we provide suggestions how you can resolve the error on your own.

Example: Either you didn't pass an API key or it is invalid. You can find or create a new API key in the environments section. It must be passed as X-API-Key header.

trace_id string

The trace ID is a unique identifier for the request. It is used to trace the request through the system. Please provide the trace_id when reporting an error to our support team.

Example: 1b935d50c2393af77b1dc92e675876a83f92ffd6

help string

This parameter provides a way to contact support. It is mainly used for developers. It is not meant to be shown to real users.

Example: If you need help, email [email protected] and include the following Trace-ID in your message: 1b935d50c2393af77b1dc92e675876a83f92ffd6.

403 Forbidden

Content Type:

The error response is returned when the user is not authorized to perform the action. The user might not have the necessary permissions or the action is not allowed in the current state of the system.

error string

The error code is a machine readable code describing the error.

Example: UNAUTHORIZED

message string

The error message is a human readable message describing the error. It is mainly used for understanding the error by developers. It is not meant to be shown to real users.

Example: This action is unauthorized.

suggestion string

For many errors we provide suggestions how you can resolve the error on your own.

Example: You are not authorized to perform this request. Please make sure you have the correct permissions and try again.

trace_id string

The trace ID is a unique identifier for the request. It is used to trace the request through the system. Please provide the trace_id when reporting an error to our support team.

Example: 1b935d50c2393af77b1dc92e675876a83f92ffd6

help string

This parameter provides a way to contact support. It is mainly used for developers. It is not meant to be shown to real users.

Example: If you need help, email [email protected] and include the following Trace-ID in your message: 1b935d50c2393af77b1dc92e675876a83f92ffd6.

404 Not Found

Content Type:

The error response is returned when either the resource was not found or the client is not authorized to access the resource. It can also mean that you tried to access an endpoint that does not exist.

error string

The error code is a machine readable code describing the error.

Example: RESOURCE_NOT_FOUND

message string

The error message is a human readable message describing the error. It is mainly used for understanding the error by developers. It is not meant to be shown to real users.

Example: Resource not found.

suggestion string

For many errors we provide suggestions how you can resolve the error on your own.

Example: The URL path is wrong or the resource you are looking for does not exist in our system. Please make sure the URL path is correct and resource UUID you have passed in the URL is valid.

trace_id string

The trace ID is a unique identifier for the request. It is used to trace the request through the system. Please provide the trace_id when reporting an error to our support team.

Example: 1b935d50c2393af77b1dc92e675876a83f92ffd6

help string

This parameter provides a way to contact support. It is mainly used for developers. It is not meant to be shown to real users.

Example: If you need help, email [email protected] and include the following Trace-ID in your message: 1b935d50c2393af77b1dc92e675876a83f92ffd6.

422 Unprocessable Entity

Content Type:

The error response is returned when the client has provided invalid data in the request.

error string

The error code is a machine readable code describing the error.

Example: VALIDATION_ERROR

message string

The error message is a human readable message describing the error. It is mainly used for understanding the error by developers. It is not meant to be shown to real users.

Example: The identity uuid field is required. | The return url field is required.

suggestion string

For many errors we provide suggestions how you can resolve the error on your own.

Example: There might be some parameters are missing or the values of parameters you have passed are invalid. Please check the payload and make sure it conforms with the rules mentioned in API doc.

trace_id string

The trace ID is a unique identifier for the request. It is used to trace the request through the system. Please provide the trace_id when reporting an error to our support team.

Example: 1b935d50c2393af77b1dc92e675876a83f92ffd6

errors object

The errors object contains a list of fields with their corresponding error messages.

Example: { "identity_uuid": [ "The identity uuid field is required." ], "return_url": [ "The return url field is required." ] }

help string

This parameter provides a way to contact support. It is mainly used for developers. It is not meant to be shown to real users.

Example: If you need help, email [email protected] and include the following Trace-ID in your message: 1b935d50c2393af77b1dc92e675876a83f92ffd6.

500 Internal Server Error

Content Type:

The error response is returned when an unknown server error occurred. Unfortunately, there is nothing you can do to resolve the error on your own. Please try again later or contact support and provide the trace_id.

error string

The error code is a machine readable code describing the error.

Example: UNKNOWN_SERVER_ERROR

message string

The error message is a human readable message describing the error. It is mainly used for understanding the error by developers. It is not meant to be shown to real users.

Example: An unknown server error occurred. Please try again later or contact support.

suggestion string

For many errors we provide suggestions how you can resolve the error on your own.

Example: Either you didn't pass an API key or it is invalid. You can find or create a new API key in the environments section. It must be passed as X-API-Key header.

trace_id string

The trace ID is a unique identifier for the request. It is used to trace the request through the system. Please provide the trace_id when reporting an error to our support team.

Example: 1b935d50c2393af77b1dc92e675876a83f92ffd6

help string

This parameter provides a way to contact support. It is mainly used for developers. It is not meant to be shown to real users.

Example: If you need help, email [email protected] and include the following Trace-ID in your message: 1b935d50c2393af77b1dc92e675876a83f92ffd6.

Response Examples

{
  "data": {
    "uuid": "3598b23c-31db-4be9-9e6b-6aa1d5b60335"
  }
}
    

{ "error": "API_KEY_MISSING_OR_INVALID", "message": "API key is missing or invalid.", "suggestion": "Either you didn't pass an API key or it is invalid. You can find or create a new API key in the environments section. It must be passed as X-API-Key header.", "trace_id": "1b935d50c2393af77b1dc92e675876a83f92ffd6", "help": "If you need help, email [email protected] and include the following Trace-ID in your message: 1b935d50c2393af77b1dc92e675876a83f92ffd6." }

{ "error": "UNAUTHORIZED", "message": "This action is unauthorized.", "suggestion": "You are not authorized to perform this request. Please make sure you have the correct permissions and try again.", "trace_id": "1b935d50c2393af77b1dc92e675876a83f92ffd6", "help": "If you need help, email [email protected] and include the following Trace-ID in your message: 1b935d50c2393af77b1dc92e675876a83f92ffd6." }

{ "error": "RESOURCE_NOT_FOUND", "message": "Resource not found.", "suggestion": "The URL path is wrong or the resource you are looking for does not exist in our system. Please make sure the URL path is correct and resource UUID you have passed in the URL is valid.", "trace_id": "1b935d50c2393af77b1dc92e675876a83f92ffd6", "help": "If you need help, email [email protected] and include the following Trace-ID in your message: 1b935d50c2393af77b1dc92e675876a83f92ffd6." }

{ "error": "VALIDATION_ERROR", "message": "The identity uuid field is required. | The return url field is required.", "suggestion": "There might be some parameters are missing or the values of parameters you have passed are invalid. Please check the payload and make sure it conforms with the rules mentioned in API doc.", "trace_id": "1b935d50c2393af77b1dc92e675876a83f92ffd6", "errors": { "identity_uuid": [ "The identity uuid field is required." ], "return_url": [ "The return url field is required." ] }, "help": "If you need help, email [email protected] and include the following Trace-ID in your message: 1b935d50c2393af77b1dc92e675876a83f92ffd6." }

{ "error": "UNKNOWN_SERVER_ERROR", "message": "An unknown server error occurred. Please try again later or contact support.", "suggestion": "Either you didn't pass an API key or it is invalid. You can find or create a new API key in the environments section. It must be passed as X-API-Key header.", "trace_id": "1b935d50c2393af77b1dc92e675876a83f92ffd6", "help": "If you need help, email [email protected] and include the following Trace-ID in your message: 1b935d50c2393af77b1dc92e675876a83f92ffd6." }

Body Parameters