{
  "openapi": "3.0.0",
  "info": {
    "title": "",
    "description": "",
    "version": "0.0.1"
  },
  "servers": [
    {
      "url": "https://dev.seqhq.io",
      "description": "E2E"
    },
    {
      "url": "https://dev.seqhq.io",
      "description": "DEV"
    },
    {
      "url": "https://sandbox.sequencehq.com",
      "description": "SANDBOX"
    },
    {
      "url": "https://eu.sequencehq.com",
      "description": "PRODUCTION"
    }
  ],
  "tags": [
    {
      "name": "Activities"
    }
  ],
  "paths": {
    "/activity-logs/{id}": {
      "get": {
        "tags": [
          "Activities"
        ],
        "summary": "Get an Activity Log by ID",
        "description": "Get an Activity Log by ID",
        "operationId": "getActivityLogsById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Authorization",
            "in": "header",
            "description": "Your [API credentials](/reference/authentication). Eg. `Basic {credentials}`.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "sequence-version",
            "in": "header",
            "description": "Use this header to select an API version",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "2024-07-30"
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ActivityLogResponse",
                  "example": {
                    "id": "aa0e8400-e29b-41d4-a716-446655440005",
                    "sequenceAccountId": "bb0e8400-e29b-41d4-a716-446655440006",
                    "activityType": "NOTIFICATION",
                    "apiVersion": "V1",
                    "origin": "API",
                    "traceId": "f26ad30d3be41b2f64fa7dbfb22ba5fd",
                    "createdAt": "2024-01-01T10:00:00Z",
                    "activityLogItems": [
                      {
                        "id": "880e8400-e29b-41d4-a716-446655440003",
                        "activityLogId": "990e8400-e29b-41d4-a716-446655440004",
                        "verb": "CREATED",
                        "name": "Invoice Created",
                        "summary": "A new invoice was created for customer",
                        "reason": "New billing cycle started",
                        "metadata": [],
                        "activityLogActor": {
                          "id": "550e8400-e29b-41d4-a716-446655440000",
                          "entityType": "USER",
                          "entityId": "550e8400-e29b-41d4-a716-446655440123",
                          "email": "john.doe@sequencehq.com"
                        },
                        "activityLogObject": {
                          "id": "660e8400-e29b-41d4-a716-446655440001",
                          "entityType": "INVOICE",
                          "entityId": "550e8400-e29b-41d4-a716-446655440456"
                        },
                        "activityLogTarget": {
                          "id": "770e8400-e29b-41d4-a716-446655440002",
                          "entityType": "SEQUENCE_USER",
                          "entityId": "550e8400-e29b-41d4-a716-446655440789"
                        }
                      }
                    ]
                  }
                },
                "examples": {
                  "ActivityLogResponse": {
                    "summary": "",
                    "value": {
                      "id": "aa0e8400-e29b-41d4-a716-446655440005",
                      "sequenceAccountId": "bb0e8400-e29b-41d4-a716-446655440006",
                      "activityType": "NOTIFICATION",
                      "apiVersion": "V1",
                      "origin": "API",
                      "traceId": "f26ad30d3be41b2f64fa7dbfb22ba5fd",
                      "createdAt": "2024-01-01T10:00:00Z",
                      "activityLogItems": [
                        {
                          "id": "880e8400-e29b-41d4-a716-446655440003",
                          "activityLogId": "990e8400-e29b-41d4-a716-446655440004",
                          "verb": "CREATED",
                          "name": "Invoice Created",
                          "summary": "A new invoice was created for customer",
                          "reason": "New billing cycle started",
                          "metadata": [],
                          "activityLogActor": {
                            "id": "550e8400-e29b-41d4-a716-446655440000",
                            "entityType": "USER",
                            "entityId": "550e8400-e29b-41d4-a716-446655440123",
                            "email": "john.doe@sequencehq.com"
                          },
                          "activityLogObject": {
                            "id": "660e8400-e29b-41d4-a716-446655440001",
                            "entityType": "INVOICE",
                            "entityId": "550e8400-e29b-41d4-a716-446655440456"
                          },
                          "activityLogTarget": {
                            "id": "770e8400-e29b-41d4-a716-446655440002",
                            "entityType": "SEQUENCE_USER",
                            "entityId": "550e8400-e29b-41d4-a716-446655440789"
                          }
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {}
          },
          "401": {
            "description": "Unauthorized",
            "content": {}
          },
          "500": {
            "description": "Internal Server Error",
            "content": {}
          }
        }
      },
      "servers": [],
      "parameters": []
    },
    "/activity-logs": {
      "get": {
        "tags": [
          "Activities"
        ],
        "summary": "List all Activity Logs",
        "description": "List all Activity Logs",
        "operationId": "getActivityLogs",
        "parameters": [
          {
            "name": "Authorization",
            "in": "header",
            "description": "Your [API credentials](/reference/authentication). Eg. `Basic {credentials}`.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "before",
            "in": "query",
            "description": "Pagination cursor. To page through items, omit this parameter to retrieve the first page, and then successively use the value you get from `pagination.after` or `pagination.before` to retrieve each page.",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "after",
            "in": "query",
            "description": "Pagination cursor. To page through items, omit this parameter to retrieve the first page, and then successively use the value you get from `pagination.after` or `pagination.before` to retrieve each page.",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "description": "Maximum number of objects to return per-page. Must be between 1 and 100 (inclusive).",
            "required": false,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "sortOrder",
            "in": "query",
            "description": "Sort order. Default: DESC (descending, most often used for reverse chronological sorting).",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "activityLogObjectId",
            "in": "query",
            "description": "Filter by activity log object ID",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "activityLogObjectEntityId",
            "in": "query",
            "description": "Filter by activity log object entity ID",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "sequence-version",
            "in": "header",
            "description": "Use this header to select an API version",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "2024-07-30"
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ActivityLogListResponse",
                  "example": {
                    "items": [
                      {
                        "id": "aa0e8400-e29b-41d4-a716-446655440005",
                        "sequenceAccountId": "bb0e8400-e29b-41d4-a716-446655440006",
                        "activityType": "NOTIFICATION",
                        "apiVersion": "V1",
                        "origin": "API",
                        "traceId": "f26ad30d3be41b2f64fa7dbfb22ba5fd",
                        "createdAt": "2024-01-01T10:00:00Z",
                        "activityLogItems": [
                          {
                            "id": "880e8400-e29b-41d4-a716-446655440003",
                            "activityLogId": "990e8400-e29b-41d4-a716-446655440004",
                            "verb": "CREATED",
                            "name": "Invoice Created",
                            "summary": "A new invoice was created for customer",
                            "reason": "New billing cycle started",
                            "metadata": [],
                            "activityLogActor": {
                              "id": "550e8400-e29b-41d4-a716-446655440000",
                              "entityType": "USER",
                              "entityId": "550e8400-e29b-41d4-a716-446655440123",
                              "email": "john.doe@sequencehq.com"
                            },
                            "activityLogObject": {
                              "id": "660e8400-e29b-41d4-a716-446655440001",
                              "entityType": "INVOICE",
                              "entityId": "550e8400-e29b-41d4-a716-446655440456"
                            },
                            "activityLogTarget": {
                              "id": "770e8400-e29b-41d4-a716-446655440002",
                              "entityType": "SEQUENCE_USER",
                              "entityId": "550e8400-e29b-41d4-a716-446655440789"
                            }
                          }
                        ]
                      }
                    ],
                    "pagination": {
                      "after": "MDE4NDUyNjYtNmQ2NC03N2M4LTlhZGYtNDQ4N2Q5NGQxNDU3",
                      "before": "MDE4NDQyMWUtYTljYy03MTFiLWFmOTMtYmYwNTExZDRkODMz",
                      "totalResultSize": 10
                    }
                  }
                },
                "examples": {
                  "ActivityLogListResponse": {
                    "summary": "",
                    "value": {
                      "items": [
                        {
                          "id": "aa0e8400-e29b-41d4-a716-446655440005",
                          "sequenceAccountId": "bb0e8400-e29b-41d4-a716-446655440006",
                          "activityType": "NOTIFICATION",
                          "apiVersion": "V1",
                          "origin": "API",
                          "traceId": "f26ad30d3be41b2f64fa7dbfb22ba5fd",
                          "createdAt": "2024-01-01T10:00:00Z",
                          "activityLogItems": [
                            {
                              "id": "880e8400-e29b-41d4-a716-446655440003",
                              "activityLogId": "990e8400-e29b-41d4-a716-446655440004",
                              "verb": "CREATED",
                              "name": "Invoice Created",
                              "summary": "A new invoice was created for customer",
                              "reason": "New billing cycle started",
                              "metadata": [],
                              "activityLogActor": {
                                "id": "550e8400-e29b-41d4-a716-446655440000",
                                "entityType": "USER",
                                "entityId": "550e8400-e29b-41d4-a716-446655440123",
                                "email": "john.doe@sequencehq.com"
                              },
                              "activityLogObject": {
                                "id": "660e8400-e29b-41d4-a716-446655440001",
                                "entityType": "INVOICE",
                                "entityId": "550e8400-e29b-41d4-a716-446655440456"
                              },
                              "activityLogTarget": {
                                "id": "770e8400-e29b-41d4-a716-446655440002",
                                "entityType": "SEQUENCE_USER",
                                "entityId": "550e8400-e29b-41d4-a716-446655440789"
                              }
                            }
                          ]
                        }
                      ],
                      "pagination": {
                        "after": "MDE4NDUyNjYtNmQ2NC03N2M4LTlhZGYtNDQ4N2Q5NGQxNDU3",
                        "before": "MDE4NDQyMWUtYTljYy03MTFiLWFmOTMtYmYwNTExZDRkODMz",
                        "totalResultSize": 10
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {}
          },
          "401": {
            "description": "Unauthorized",
            "content": {}
          },
          "500": {
            "description": "Internal Server Error",
            "content": {}
          }
        }
      },
      "servers": [],
      "parameters": []
    }
  },
  "components": {
    "schemas": {
      "ActivityLogResponse": {
        "required": [
          "activityLogItems",
          "activityType",
          "createdAt",
          "id",
          "origin",
          "sequenceAccountId"
        ],
        "type": "object",
        "example": {
          "id": "aa0e8400-e29b-41d4-a716-446655440005",
          "sequenceAccountId": "bb0e8400-e29b-41d4-a716-446655440006",
          "activityType": "NOTIFICATION",
          "apiVersion": "V1",
          "origin": "API",
          "traceId": "f26ad30d3be41b2f64fa7dbfb22ba5fd",
          "createdAt": "2024-01-01T10:00:00Z",
          "activityLogItems": [
            {
              "id": "880e8400-e29b-41d4-a716-446655440003",
              "activityLogId": "990e8400-e29b-41d4-a716-446655440004",
              "verb": "CREATED",
              "name": "Invoice Created",
              "summary": "A new invoice was created for customer",
              "reason": "New billing cycle started",
              "metadata": [],
              "activityLogActor": {
                "id": "550e8400-e29b-41d4-a716-446655440000",
                "entityType": "USER",
                "entityId": "550e8400-e29b-41d4-a716-446655440123",
                "email": "john.doe@sequencehq.com"
              },
              "activityLogObject": {
                "id": "660e8400-e29b-41d4-a716-446655440001",
                "entityType": "INVOICE",
                "entityId": "550e8400-e29b-41d4-a716-446655440456"
              },
              "activityLogTarget": {
                "id": "770e8400-e29b-41d4-a716-446655440002",
                "entityType": "SEQUENCE_USER",
                "entityId": "550e8400-e29b-41d4-a716-446655440789"
              }
            }
          ]
        },
        "properties": {
          "id": {
            "type": "string",
            "example": "aa0e8400-e29b-41d4-a716-446655440005"
          },
          "sequenceAccountId": {
            "type": "string",
            "example": "bb0e8400-e29b-41d4-a716-446655440006"
          },
          "activityType": {
            "type": "string",
            "example": "NOTIFICATION"
          },
          "apiVersion": {
            "type": "string",
            "example": "V1"
          },
          "origin": {
            "type": "string",
            "example": "API"
          },
          "traceId": {
            "type": "string",
            "example": "f26ad30d3be41b2f64fa7dbfb22ba5fd"
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "example": "2024-01-01T10:00:00Z"
          },
          "activityLogItems": {
            "type": "array",
            "example": [
              {
                "id": "880e8400-e29b-41d4-a716-446655440003",
                "activityLogId": "990e8400-e29b-41d4-a716-446655440004",
                "verb": "CREATED",
                "name": "Invoice Created",
                "summary": "A new invoice was created for customer",
                "reason": "New billing cycle started",
                "metadata": [],
                "activityLogActor": {
                  "id": "550e8400-e29b-41d4-a716-446655440000",
                  "entityType": "USER",
                  "entityId": "550e8400-e29b-41d4-a716-446655440123",
                  "email": "john.doe@sequencehq.com"
                },
                "activityLogObject": {
                  "id": "660e8400-e29b-41d4-a716-446655440001",
                  "entityType": "INVOICE",
                  "entityId": "550e8400-e29b-41d4-a716-446655440456"
                },
                "activityLogTarget": {
                  "id": "770e8400-e29b-41d4-a716-446655440002",
                  "entityType": "SEQUENCE_USER",
                  "entityId": "550e8400-e29b-41d4-a716-446655440789"
                }
              }
            ],
            "items": {
              "$ref": "#/components/schemas/ActivityLogItemResponse"
            }
          }
        }
      },
      "ActivityLogItemResponse": {
        "required": [
          "activityLogActor",
          "activityLogId",
          "activityLogObject",
          "id",
          "name",
          "summary",
          "verb"
        ],
        "type": "object",
        "example": {
          "id": "880e8400-e29b-41d4-a716-446655440003",
          "activityLogId": "990e8400-e29b-41d4-a716-446655440004",
          "verb": "CREATED",
          "name": "Invoice Created",
          "summary": "A new invoice was created for customer",
          "reason": "New billing cycle started",
          "metadata": [],
          "activityLogActor": {
            "id": "550e8400-e29b-41d4-a716-446655440000",
            "entityType": "USER",
            "entityId": "550e8400-e29b-41d4-a716-446655440123",
            "email": "john.doe@sequencehq.com"
          },
          "activityLogObject": {
            "id": "660e8400-e29b-41d4-a716-446655440001",
            "entityType": "INVOICE",
            "entityId": "550e8400-e29b-41d4-a716-446655440456"
          },
          "activityLogTarget": {
            "id": "770e8400-e29b-41d4-a716-446655440002",
            "entityType": "SEQUENCE_USER",
            "entityId": "550e8400-e29b-41d4-a716-446655440789"
          }
        },
        "properties": {
          "id": {
            "type": "string",
            "example": "880e8400-e29b-41d4-a716-446655440003"
          },
          "activityLogId": {
            "type": "string",
            "example": "990e8400-e29b-41d4-a716-446655440004"
          },
          "verb": {
            "type": "string",
            "example": "CREATED"
          },
          "name": {
            "type": "string",
            "example": "Invoice Created"
          },
          "summary": {
            "type": "string",
            "example": "A new invoice was created for customer"
          },
          "reason": {
            "type": "string",
            "example": "New billing cycle started"
          },
          "metadata": {
            "type": "array",
            "example": [],
            "items": {}
          },
          "activityLogActor": {
            "$ref": "#/components/schemas/ActivityLogActorResponse"
          },
          "activityLogObject": {
            "$ref": "#/components/schemas/ActivityLogObjectResponse"
          },
          "activityLogTarget": {
            "$ref": "#/components/schemas/ActivityLogTargetResponse"
          }
        }
      },
      "ActivityLogActorResponse": {
        "required": [
          "entityType",
          "id"
        ],
        "type": "object",
        "example": {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "entityType": "USER",
          "entityId": "550e8400-e29b-41d4-a716-446655440123",
          "email": "john.doe@sequencehq.com"
        },
        "properties": {
          "id": {
            "type": "string",
            "example": "550e8400-e29b-41d4-a716-446655440000"
          },
          "entityType": {
            "type": "string",
            "example": "USER"
          },
          "entityId": {
            "type": "string",
            "example": "550e8400-e29b-41d4-a716-446655440123"
          },
          "email": {
            "type": "string",
            "example": "john.doe@sequencehq.com"
          }
        }
      },
      "ActivityLogObjectResponse": {
        "required": [
          "entityType",
          "id"
        ],
        "type": "object",
        "example": {
          "id": "660e8400-e29b-41d4-a716-446655440001",
          "entityType": "INVOICE",
          "entityId": "550e8400-e29b-41d4-a716-446655440456"
        },
        "properties": {
          "id": {
            "type": "string",
            "example": "660e8400-e29b-41d4-a716-446655440001"
          },
          "entityType": {
            "type": "string",
            "example": "INVOICE"
          },
          "entityId": {
            "type": "string",
            "example": "550e8400-e29b-41d4-a716-446655440456"
          }
        }
      },
      "ActivityLogTargetResponse": {
        "required": [
          "entityType",
          "id"
        ],
        "type": "object",
        "example": {
          "id": "770e8400-e29b-41d4-a716-446655440002",
          "entityType": "SEQUENCE_USER",
          "entityId": "550e8400-e29b-41d4-a716-446655440789"
        },
        "properties": {
          "id": {
            "type": "string",
            "example": "770e8400-e29b-41d4-a716-446655440002"
          },
          "entityType": {
            "type": "string",
            "example": "SEQUENCE_USER"
          },
          "entityId": {
            "type": "string",
            "example": "550e8400-e29b-41d4-a716-446655440789"
          }
        }
      },
      "ActivityLogListResponse": {
        "required": [
          "items",
          "pagination"
        ],
        "type": "object",
        "example": {
          "items": [
            {
              "id": "aa0e8400-e29b-41d4-a716-446655440005",
              "sequenceAccountId": "bb0e8400-e29b-41d4-a716-446655440006",
              "activityType": "NOTIFICATION",
              "apiVersion": "V1",
              "origin": "API",
              "traceId": "f26ad30d3be41b2f64fa7dbfb22ba5fd",
              "createdAt": "2024-01-01T10:00:00Z",
              "activityLogItems": [
                {
                  "id": "880e8400-e29b-41d4-a716-446655440003",
                  "activityLogId": "990e8400-e29b-41d4-a716-446655440004",
                  "verb": "CREATED",
                  "name": "Invoice Created",
                  "summary": "A new invoice was created for customer",
                  "reason": "New billing cycle started",
                  "metadata": [],
                  "activityLogActor": {
                    "id": "550e8400-e29b-41d4-a716-446655440000",
                    "entityType": "USER",
                    "entityId": "550e8400-e29b-41d4-a716-446655440123",
                    "email": "john.doe@sequencehq.com"
                  },
                  "activityLogObject": {
                    "id": "660e8400-e29b-41d4-a716-446655440001",
                    "entityType": "INVOICE",
                    "entityId": "550e8400-e29b-41d4-a716-446655440456"
                  },
                  "activityLogTarget": {
                    "id": "770e8400-e29b-41d4-a716-446655440002",
                    "entityType": "SEQUENCE_USER",
                    "entityId": "550e8400-e29b-41d4-a716-446655440789"
                  }
                }
              ]
            }
          ],
          "pagination": {
            "after": "MDE4NDUyNjYtNmQ2NC03N2M4LTlhZGYtNDQ4N2Q5NGQxNDU3",
            "before": "MDE4NDQyMWUtYTljYy03MTFiLWFmOTMtYmYwNTExZDRkODMz",
            "totalResultSize": 10
          }
        },
        "properties": {
          "items": {
            "type": "array",
            "example": [
              {
                "id": "aa0e8400-e29b-41d4-a716-446655440005",
                "sequenceAccountId": "bb0e8400-e29b-41d4-a716-446655440006",
                "activityType": "NOTIFICATION",
                "apiVersion": "V1",
                "origin": "API",
                "traceId": "f26ad30d3be41b2f64fa7dbfb22ba5fd",
                "createdAt": "2024-01-01T10:00:00Z",
                "activityLogItems": [
                  {
                    "id": "880e8400-e29b-41d4-a716-446655440003",
                    "activityLogId": "990e8400-e29b-41d4-a716-446655440004",
                    "verb": "CREATED",
                    "name": "Invoice Created",
                    "summary": "A new invoice was created for customer",
                    "reason": "New billing cycle started",
                    "metadata": [],
                    "activityLogActor": {
                      "id": "550e8400-e29b-41d4-a716-446655440000",
                      "entityType": "USER",
                      "entityId": "550e8400-e29b-41d4-a716-446655440123",
                      "email": "john.doe@sequencehq.com"
                    },
                    "activityLogObject": {
                      "id": "660e8400-e29b-41d4-a716-446655440001",
                      "entityType": "INVOICE",
                      "entityId": "550e8400-e29b-41d4-a716-446655440456"
                    },
                    "activityLogTarget": {
                      "id": "770e8400-e29b-41d4-a716-446655440002",
                      "entityType": "SEQUENCE_USER",
                      "entityId": "550e8400-e29b-41d4-a716-446655440789"
                    }
                  }
                ]
              }
            ],
            "items": {
              "$ref": "#/components/schemas/ActivityLogResponse"
            }
          },
          "pagination": {
            "$ref": "#/components/schemas/PaginationMeta"
          }
        }
      },
      "PaginationMeta": {
        "type": "object",
        "example": {
          "after": "MDE4NDUyNjYtNmQ2NC03N2M4LTlhZGYtNDQ4N2Q5NGQxNDU3",
          "before": "MDE4NDQyMWUtYTljYy03MTFiLWFmOTMtYmYwNTExZDRkODMz",
          "totalResultSize": 10
        },
        "properties": {
          "after": {
            "type": "string",
            "description": "Cursor for the page after this (if it exists)",
            "example": "MDE4NDUyNjYtNmQ2NC03N2M4LTlhZGYtNDQ4N2Q5NGQxNDU3"
          },
          "before": {
            "type": "string",
            "description": "Cursor for the page before this (if it exists)",
            "example": "MDE4NDQyMWUtYTljYy03MTFiLWFmOTMtYmYwNTExZDRkODMz"
          },
          "totalResultSize": {
            "type": "integer",
            "description": "Total number of entries across all pages",
            "format": "int64",
            "example": 10
          }
        }
      }
    },
    "requestBodies": {},
    "securitySchemes": {}
  }
}