---
updatedAt: 2026-04-21T20:06:09.000Z
agentTools:
  projectIndex: https://docs.gifq.com/llms.txt
---

# Get campaign

Retrieves the full details of a single campaign by its ID.

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "GIFQ External API Reference",
    "version": "v1",
    "description": "Public API documentation for GIFQ external partners."
  },
  "components": {
    "securitySchemes": {
      "X-Api-Token": {
        "type": "apiKey",
        "name": "X-Api-Token",
        "in": "header",
        "description": "API token for authentication"
      }
    }
  },
  "paths": {
    "/api/campaigns/{id}": {
      "get": {
        "summary": "Get campaign",
        "tags": [
          "Campaigns"
        ],
        "description": "Retrieves the full details of a single campaign by its ID.",
        "security": [
          {
            "X-Api-Token": []
          }
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "description": "ID of the campaign to retrieve",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Campaign returned",
            "content": {
              "application/json": {
                "example": {
                  "id": "f8ff485f-2702-4586-8fd7-9b1208839a62",
                  "name": "Campaign 3",
                  "sender": "GIFQ",
                  "description": null,
                  "status": "active",
                  "payout_types": [
                    "gift_cards"
                  ],
                  "website": {
                    "headline": "Hello {{recipient_name}}, you have a gift!",
                    "body": "You have received {{amount}} as a gift card."
                  },
                  "email": {
                    "subject": "{{recipient_name}}, you have received a gift!",
                    "body": "Dear {{recipient_name}}, you have been gifted {{amount}}."
                  },
                  "created_at": "2026-10-05T10:22:11.860Z",
                  "updated_at": "2026-10-05T10:22:11.860Z",
                  "brands_count": 1
                },
                "schema": {
                  "type": "object",
                  "required": [
                    "id",
                    "name",
                    "sender",
                    "status",
                    "brands_count",
                    "website",
                    "email",
                    "created_at",
                    "updated_at"
                  ],
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "Unique campaign identifier"
                    },
                    "name": {
                      "type": "string",
                      "description": "Campaign name"
                    },
                    "sender": {
                      "type": "string",
                      "description": "Sender name shown in outgoing emails"
                    },
                    "description": {
                      "type": "string",
                      "nullable": true,
                      "description": "Optional campaign description"
                    },
                    "status": {
                      "type": "string",
                      "enum": [
                        "active",
                        "archived"
                      ],
                      "description": "Current lifecycle status of the campaign"
                    },
                    "brands_count": {
                      "type": "integer",
                      "description": "Number of gift card brands recipients can choose from"
                    },
                    "website": {
                      "type": "object",
                      "required": [
                        "headline",
                        "body"
                      ],
                      "properties": {
                        "headline": {
                          "type": "string",
                          "description": "Headline displayed on the redeem page"
                        },
                        "body": {
                          "type": "string",
                          "description": "Body text displayed on the redeem page"
                        }
                      }
                    },
                    "email": {
                      "type": "object",
                      "required": [
                        "subject",
                        "body"
                      ],
                      "properties": {
                        "subject": {
                          "type": "string",
                          "description": "Subject line of the redeem email"
                        },
                        "body": {
                          "type": "string",
                          "description": "Body text of the redeem email"
                        }
                      }
                    },
                    "created_at": {
                      "type": "string",
                      "format": "date-time",
                      "description": "Timestamp when the campaign was created"
                    },
                    "updated_at": {
                      "type": "string",
                      "format": "date-time",
                      "description": "Timestamp when the campaign was last updated"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Missing or incorrect API token",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "example": {
                    "message": "Unauthorized",
                    "status": "error"
                  },
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "Error message"
                    },
                    "status": {
                      "type": "string",
                      "example": "error"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Access denied",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "example": {
                    "message": "Forbidden",
                    "status": "error"
                  },
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "Error message"
                    },
                    "status": {
                      "type": "string",
                      "example": "error"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Campaign not found",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "example": {
                    "message": "Record Not Found",
                    "status": "error"
                  },
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "Error message"
                    },
                    "status": {
                      "type": "string",
                      "example": "error"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string",
                      "example": "Too many requests. Try again later."
                    },
                    "status": {
                      "type": "string",
                      "example": "error"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://{environment}.gifq.com",
      "variables": {
        "environment": {
          "default": "api-sandbox",
          "enum": [
            "api",
            "api-sandbox"
          ]
        }
      }
    }
  ]
}
```